Class RealtimeDirectThread

Hierarchy

DirectEventTypesFacade
- RealtimeDirectThread

Index

Constructors

constructor

new RealtimeDirectThread($: Observable<DirectThreadEvent<any>>, options: DirectThreadOptions, topic: RealtimeTopic, request: RealtimeRequest): RealtimeDirectThread
Parameters
- $: Observable<DirectThreadEvent<any>>
- options: DirectThreadOptions
- topic: RealtimeTopic
- request: RealtimeRequest
Returns RealtimeDirectThread

Inherited from DirectEventTypesFacade.constructor

Properties

`Readonly` $

$: Observable<DirectThreadEvent<any>>

activityIndicator

activityIndicator: DirectEventsOperationObservables<ThreadActivityIndicatorPayload> = 'direct-thread-activity-indicator'

adminUserIds

adminUserIds: DirectEventsOperationObservables<ThreadAdminUserIdsPayload> = 'direct-thread-admin-user-ids'

approvalRequired

approvalRequired: DirectEventsOperationObservables<{}> = 'direct-thread-approval-required'

hasSeen

hasSeen: DirectEventsOperationObservables<ThreadHasSeenPayload> = 'direct-thread-has-seen'

message

message: DirectEventsOperationObservables<ThreadMessagePayload> = 'direct-thread-message'

`Private` `Readonly` options

options: DirectThreadOptions

reaction

reaction: DirectEventsOperationObservables<ThreadReactionPayload> = 'direct-thread-reaction'

`Private` `Readonly` request

request: RealtimeRequest

shhMode

shhMode: DirectEventsOperationObservables<ThreadShhModePayload> = 'direct-thread-shh-mode'

theme

theme: DirectEventsOperationObservables<ThreadThemePayload> = 'direct-thread-theme'

`Private` `Readonly` topic

topic: RealtimeTopic

update

update: DirectEventsOperationObservables<ThreadUpdatePayload> = 'direct-thread-update'

Methods

`Private` execute

execute(options: any): Promise<DirectItemAckResponse>
Parameters
- options: any
Returns Promise<DirectItemAckResponse>

indicateActivity

indicateActivity(options: {
activity_status?: TypingStatus;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  activity_status?: TypingStatus;
  }
  - Optional activity_status?: TypingStatus
Returns Promise<DirectItemAckResponse>

markAsSeen

markAsSeen(options: {
item_id: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  item_id: string;
  }
  - item_id: string
Returns Promise<DirectItemAckResponse>

markVisualItemSeen

markVisualItemSeen(options: {
itemId: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  itemId: string;
  }
  - itemId: string
Returns Promise<DirectItemAckResponse>

sendHashtag

sendHashtag(options: {
hashtag: string;
text?: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  hashtag: string;
  text?: string;
  }
  - hashtag: string
  - Optional text?: string
Returns Promise<DirectItemAckResponse>

sendItem

sendItem(options: any): Promise<DirectItemAckResponse>
Parameters
- options: any
Returns Promise<DirectItemAckResponse>

sendLike

sendLike(): Promise<DirectItemAckResponse>
Returns Promise<DirectItemAckResponse>

sendLink

sendLink(options: {
link_text: string;
link_urls: string[];
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  link_text: string;
  link_urls: string[];
  }
  - link_text: string
  - link_urls: string[]
Returns Promise<DirectItemAckResponse>

sendLocation

sendLocation(options: {
text?: string;
venue_id: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  text?: string;
  venue_id: string;
  }
  - Optional text?: string
  - venue_id: string
Returns Promise<DirectItemAckResponse>

sendMedia

sendMedia(options: {
media_id: string;
text?: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  media_id: string;
  text?: string;
  }
  - media_id: string
  - Optional text?: string
Returns Promise<DirectItemAckResponse>

sendProfile

sendProfile(options: {
profile_user_id: string;
text?: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  profile_user_id: string;
  text?: string;
  }
  - profile_user_id: string
  - Optional text?: string
Returns Promise<DirectItemAckResponse>

sendReaction

sendReaction(options: {
    emoji?: string;
    item_id: string;
    reaction_status?: "created" | "deleted";
    target_item_type?: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
      emoji?: string;
      item_id: string;
      reaction_status?: "created" | "deleted";
      target_item_type?: string;
  }
  - Optional emoji?: string
  - item_id: string
  - Optional reaction_status?: "created" | "deleted"
  - Optional target_item_type?: string
Returns Promise<DirectItemAckResponse>

sendText

sendText(options: {
skipUrlCheck?: boolean;
text: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  skipUrlCheck?: boolean;
  text: string;
  }
  - Optional skipUrlCheck?: boolean
  - text: string
Returns Promise<DirectItemAckResponse>

sendUserStory

sendUserStory(options: {
media_id: string;
text?: string;
}): Promise<DirectItemAckResponse>
Parameters
- options: {
  media_id: string;
  text?: string;
  }
  - media_id: string
  - Optional text?: string
Returns Promise<DirectItemAckResponse>