ChatService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• roomCreate
• roomInfo
• roomInvite
• roomLevae
• roomList
• roomUpdate

Constructors

constructor

• new ChatService(httpRequest: BaseHttpRequest): ChatService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ChatService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicroomCreate

• roomCreate(__namedParameters: { requestBody: CreateRoomParam }): CancelablePromise<{ data?: CreateRoomResponse }>

• Create a chat Creates a new chat. If a 1:1 chat with the specified member already exists, the response will not create a duplicate but instead return the existing chat's information. For group chats with specified members, a new chat will be created even if one already exists with the same members.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: CreateRoomParam }

  Returns CancelablePromise<{ data?: CreateRoomResponse }>

  any Successfully created the chat.

publicroomInfo

• roomInfo(__namedParameters: { roomId: string; targetUserId?: string }): CancelablePromise<{ data?: GetRoomResponse }>

• Get a chat's information Retrieves information about a chat.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { roomId: string; targetUserId?: string }

  Returns CancelablePromise<{ data?: GetRoomResponse }>

  any Successfully retrieved the chat's information.

publicroomInvite

• roomInvite(__namedParameters: { requestBody: InviteRoomParam }): CancelablePromise<{ data?: InviteRoomResponse }>

• Invite people Invites people to a chat.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: InviteRoomParam }

  Returns CancelablePromise<{ data?: InviteRoomResponse }>

  any Successfully invited people to the chat.

publicroomLevae

• roomLevae(__namedParameters: { requestBody: LeaveRoomParam }): CancelablePromise<{ data?: LeaveRoomResponse }>

• Leave a chat The use leaves a chat.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: LeaveRoomParam }

  Returns CancelablePromise<{ data?: LeaveRoomResponse }>

  any Successfully left the chat.

publicroomList

• roomList(__namedParameters: { filter?: all | starred | unread; limit?: number; offset?: string; offsetOrderType?: less | eq_less | greater | eq_greater; page?: number; search?: string }): CancelablePromise<{ data?: GetRoomListResponse }>

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

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { filter?: all | starred | unread; limit?: number; offset?: string; offsetOrderType?: less | eq_less | greater | eq_greater; page?: number; search?: string }

  Returns CancelablePromise<{ data?: GetRoomListResponse }>

  any Successfully retrieved the chats.

publicroomUpdate

• roomUpdate(__namedParameters: { requestBody: UpdateRoomParam }): CancelablePromise<{ data?: UpdateRoomResponse }>

• Update a chat Updates an existing chat.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: UpdateRoomParam }

  Returns CancelablePromise<{ data?: UpdateRoomResponse }>

  any Successfully updated the chat.