ChannelService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• channelAddChannelUserInvite
• channelCreate
• channelDelChannelUser
• channelInfo
• channelList
• channelUpdate
• channelUpdateChannelArchive
• channelUserList

Constructors

constructor

• new ChannelService(httpRequest: BaseHttpRequest): ChannelService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ChannelService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicchannelAddChannelUserInvite

• channelAddChannelUserInvite(__namedParameters: { requestBody: AddChannelUserInviteParam }): CancelablePromise<any>

• Invite a user to the channel Invites a user to a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddChannelUserInviteParam }

  Returns CancelablePromise<any>

  any Successfully invited the users to the channel.

publicchannelCreate

• channelCreate(__namedParameters: { requestBody: AddChannelParam }): CancelablePromise<{ data?: AddChannelResponse }>

• Create a channel Creates a new channel in a workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddChannelParam }

  Returns CancelablePromise<{ data?: AddChannelResponse }>

  any Successfully created the channel.

publicchannelDelChannelUser

• channelDelChannelUser(__namedParameters: { requestBody: DelChannelUserParam }): CancelablePromise<any>

• Remove users from a channel Removes users from a channel

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelChannelUserParam }

  Returns CancelablePromise<any>

  any Successfully removed the users from the channel

publicchannelInfo

• channelInfo(__namedParameters: { id: string }): CancelablePromise<{ data?: GetChannelResponse }>

• Get a channel's information Bot-compatible Retrieves information about a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { id: string }

  Returns CancelablePromise<{ data?: GetChannelResponse }>

  any Successfully retrieved the channel's information.

publicchannelList

• channelList(__namedParameters: { activity?: string; disclosure?: string; limit?: number; name?: string; offset?: string; page?: number; type?: string; workspaceId: string }): CancelablePromise<{ data?: GetChannelListResponse }>

• List out channels Lists out a given number of channels from a workspace. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { activity?: string; disclosure?: string; limit?: number; name?: string; offset?: string; page?: number; type?: string; workspaceId: string }

  Returns CancelablePromise<{ data?: GetChannelListResponse }>

  any Successfully retrieved the channels.

publicchannelUpdate

• channelUpdate(__namedParameters: { requestBody: PutChannelParam }): CancelablePromise<{ data?: PutChannelResponse }>

• Update a channel Updates an existing channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: PutChannelParam }

  Returns CancelablePromise<{ data?: PutChannelResponse }>

  any Successfully updated the channel.

publicchannelUpdateChannelArchive

• channelUpdateChannelArchive(__namedParameters: { requestBody: UpdateChannelArchiveParam }): CancelablePromise<void>

• Archive/unarchive a channel Updates a channel's archiving status.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: UpdateChannelArchiveParam }

  Returns CancelablePromise<void>

  void

publicchannelUserList

• channelUserList(__namedParameters: { channelId: string; limit?: number; offset?: string; page?: number }): CancelablePromise<{ data?: GetChannelUserListResponse }>

• List out channel members Bot-compatible Lists out a given number of members belonging to a channel. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { channelId: string; limit?: number; offset?: string; page?: number }

  Returns CancelablePromise<{ data?: GetChannelUserListResponse }>

  any Successfully retrieved the channel members.