Class DirectThreadEntity

constructor

• new DirectThreadEntity(input: DirectThreadEntityInput, directThread: DirectThreadRepository, upload: UploadRepository, media: MediaRepository): DirectThreadEntity

• Parameters

  • input: DirectThreadEntityInput
  • directThread: DirectThreadRepository
  • upload: UploadRepository
  • media: MediaRepository

  Returns DirectThreadEntity

Readonlyinput

addUser

• addUser(userIds: string[] | number[]): Promise<DirectThreadRepositoryAddUserResponseRootObject>

• Parameters

  • userIds: string[] | number[]

  Returns Promise<DirectThreadRepositoryAddUserResponseRootObject>

broadcastLink

• broadcastLink(link_text: string, link_urls: string[]): Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

• Parameters

  • link_text: string
  • link_urls: string[]

  Returns Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

broadcastProfile

• broadcastProfile(id: string | number): Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

• Parameters

  • id: string | number

  Returns Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

  Deprecated

  use DirectBroadcastProfileMessage instead

broadcastReel

• broadcastReel(options: DirectThreadBroadcastReelOptions): Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

• This is used when replying to a story (swiping up) and it's creator

  Parameters

  • options: DirectThreadBroadcastReelOptions

  Returns Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

broadcastText

• broadcastText(text: string, skipUrlCheck?: boolean): Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

• Parameters

  • text: string
  • OptionalskipUrlCheck: boolean

  Returns Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

  Deprecated

  use DirectBroadcastTextMessage instead

broadcastUserStory

• broadcastUserStory(options: DirectThreadBroadcastReelOptions): Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

• This is used when sharing a story (app: plane/share button) to a thread

  Parameters

  • options: DirectThreadBroadcastReelOptions

  Returns Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

broadcastVideo

• broadcastVideo(options: DirectThreadBroadcastVideoOptions): Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

• Parameters

  • options: DirectThreadBroadcastVideoOptions

  Returns Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

broadcastVoice

• broadcastVoice(options: DirectThreadBroadcastVoiceOptions): Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

• Parameters

  • options: DirectThreadBroadcastVoiceOptions

  Returns Promise<undefined | DirectThreadRepositoryBroadcastResponseRootObject | DirectThreadRepositoryBroadcastResponsePayload>

deleteItem

• deleteItem(itemId: string | number, extra: {
      is_ssh_mode?: "0" | "1";
      original_message_client_context?: string;
      send_attribution?: string;
  }): Promise<StatusResponse>

• Parameters

  • itemId: string | number
  • extra: {
        is_ssh_mode?: "0" | "1";
        original_message_client_context?: string;
        send_attribution?: string;
    }

    • Optionalis_ssh_mode?: "0" | "1"

    • Optionaloriginal_message_client_context?: string

    • Optionalsend_attribution?: string

  Returns Promise<StatusResponse>

hide

• hide(): Promise<StatusResponse>

• Returns Promise<StatusResponse>

leave

• leave(): Promise<StatusResponse>

• Returns Promise<StatusResponse>

markItemSeen

• markItemSeen(threadItemId: string): Promise<StatusResponse>

• Parameters

  • threadItemId: string

  Returns Promise<StatusResponse>

mute

• mute(): Promise<StatusResponse>

• Returns Promise<StatusResponse>

unmute

• unmute(): Promise<StatusResponse>

• Returns Promise<StatusResponse>

updateTitle

• updateTitle(title: string): Promise<DirectThreadRepositoryUpdateTitleResponseRootObject>

• Parameters

  • title: string

  Returns Promise<DirectThreadRepositoryUpdateTitleResponseRootObject>