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