Interface: PrivateMessageApiClientInterface
services/private_message.PrivateMessageApiClientInterface
Methods
chunkUploadDone
▸ chunkUploadDone(data, config?): Promise<SCPrivateMessageUploadMediaType>
Parameters
| Name | Type |
|---|---|
data | MessageChunkUploadDoneParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadMediaType>
Defined in
services/private_message/index.ts:34
deleteAMessage
▸ deleteAMessage(id, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/private_message/index.ts:29
deleteAThread
▸ deleteAThread(params, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
params | ThreadDeleteParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/private_message/index.ts:30
getASingleMessage
▸ getASingleMessage(id, config?): Promise<SCPrivateMessageThreadType>
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageThreadType>
Defined in
services/private_message/index.ts:27
getAThread
▸ getAThread(params, config?): Promise<SCPaginatedResponse<SCPrivateMessageThreadType>>
Parameters
| Name | Type |
|---|---|
params | ThreadParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPrivateMessageThreadType>>
Defined in
services/private_message/index.ts:26
getAllSnippets
▸ getAllSnippets(config?): Promise<SCPaginatedResponse<SCPrivateMessageSnippetType>>
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPrivateMessageSnippetType>>
Defined in
services/private_message/index.ts:25
searchUser
▸ searchUser(search, config?): Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Name | Type |
|---|---|
search | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserType>>
Defined in
services/private_message/index.ts:35
sendAMessage
▸ sendAMessage(data, config?): Promise<SCPrivateMessageThreadType>
Parameters
| Name | Type |
|---|---|
data | MessageCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageThreadType>
Defined in
services/private_message/index.ts:28
uploadMedia
▸ uploadMedia(data, config?): Promise<SCPrivateMessageUploadMediaType>
Parameters
| Name | Type |
|---|---|
data | MessageMediaUploadParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadMediaType>
Defined in
services/private_message/index.ts:31
uploadMediaInChunks
▸ uploadMediaInChunks(data, config?): Promise<SCPrivateMessageUploadMediaChunkType>
Parameters
| Name | Type |
|---|---|
data | MessageMediaChunksParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadMediaChunkType>
Defined in
services/private_message/index.ts:33
uploadThumbnail
▸ uploadThumbnail(data, config?): Promise<SCPrivateMessageUploadThumbnailType>
Parameters
| Name | Type |
|---|---|
data | MessageThumbnailUploadParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadThumbnailType>