instagram-private-api / entities / DirectThreadEntity
entities.DirectThreadEntity
-
↳
DirectThreadEntity
- addUser
- broadcastLink
- broadcastPhoto
- broadcastPost
- broadcastProfile
- broadcastReel
- broadcastStory
- broadcastText
- broadcastUserStory
- broadcastVideo
- broadcastVoice
- deleteItem
- hide
- leave
- markItemSeen
- mute
- unmute
- updateTitle
• new DirectThreadEntity(client)
| Name | Type |
|---|---|
client |
IgApiClient |
• threadId: string = null
src/entities/direct-thread.entity.ts:16
• userIds: string[] = null
src/entities/direct-thread.entity.ts:17
▸ addUser(userIds): Promise<DirectThreadRepositoryAddUserResponseRootObject>
| Name | Type |
|---|---|
userIds |
string[] | number[] |
Promise<DirectThreadRepositoryAddUserResponseRootObject>
src/entities/direct-thread.entity.ts:239
▸ broadcastLink(link_text, link_urls): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
| Name | Type |
|---|---|
link_text |
string |
link_urls |
string[] |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:95
▸ broadcastPhoto(options): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
| Name | Type |
|---|---|
options |
DirectThreadBroadcastPhotoOptions |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:105
▸ broadcastPost(mediaId): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
| Name | Type |
|---|---|
mediaId |
string |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:119
▸ broadcastProfile(id): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
| Name | Type |
|---|---|
id |
string | number |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:86
▸ broadcastReel(options): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
This is used when replying to a story (swiping up) and it's creator
| Name | Type |
|---|---|
options |
DirectThreadBroadcastReelOptions |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:52
▸ broadcastStory(input): Promise<any>
Uploads a story to the thread The story is either destroyable (view 'once') or 'replayable'
| Name | Type |
|---|---|
input |
Buffer | DirectThreadBroadcastPhotoStoryOptions | DirectThreadBroadcastVideoStoryOptions |
Promise<any>
src/entities/direct-thread.entity.ts:195
▸ broadcastText(text, skipLinkCheck?): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
Sends a text message to the thread. If the message contains links, these links will be properly displayed (turn off with {@param skipLinkCheck})
| Name | Type | Description |
|---|---|---|
text |
string |
The text to send |
skipLinkCheck? |
boolean |
May be omitted; skips checking for links. This was added to only require url-regex-safe if it's necessary as it may cause problems (See #1328). |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:33
▸ broadcastUserStory(options): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
This is used when sharing a story (app: plane/share button) to a thread
| Name | Type |
|---|---|
options |
DirectThreadBroadcastReelOptions |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:71
▸ broadcastVideo(options): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
| Name | Type |
|---|---|
options |
DirectThreadBroadcastVideoOptions |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:131
▸ broadcastVoice(options): Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
| Name | Type |
|---|---|
options |
DirectThreadBroadcastVoiceOptions |
Promise<DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>
src/entities/direct-thread.entity.ts:159
▸ deleteItem(itemId): Promise<StatusResponse>
| Name | Type |
|---|---|
itemId |
string | number |
Promise<StatusResponse>
src/entities/direct-thread.entity.ts:19
▸ hide(): Promise<StatusResponse>
Promise<StatusResponse>
src/entities/direct-thread.entity.ts:231
▸ leave(): Promise<StatusResponse>
Promise<StatusResponse>
src/entities/direct-thread.entity.ts:235
▸ markItemSeen(threadItemId): Promise<StatusResponse>
| Name | Type |
|---|---|
threadItemId |
string |
Promise<StatusResponse>
src/entities/direct-thread.entity.ts:243
▸ mute(): Promise<StatusResponse>
Promise<StatusResponse>
src/entities/direct-thread.entity.ts:223
▸ unmute(): Promise<StatusResponse>
Promise<StatusResponse>
src/entities/direct-thread.entity.ts:227
▸ updateTitle(title): Promise<DirectThreadRepositoryUpdateTitleResponseRootObject>
| Name | Type |
|---|---|
title |
string |
Promise<DirectThreadRepositoryUpdateTitleResponseRootObject>