Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Call

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Call(receiverId: any, type: any, receiverType: any, category?: any): Call

Properties

Static Readonly ACTION_TYPE

ACTION_TYPE: { TYPE_MEMBER_ADDED: string; TYPE_MEMBER_BANNED: string; TYPE_MEMBER_INVITED: string; TYPE_MEMBER_JOINED: string; TYPE_MEMBER_KICKED: string; TYPE_MEMBER_LEFT: string; TYPE_MEMBER_SCOPE_CHANGED: string; TYPE_MEMBER_UNBANNED: string; TYPE_MESSAGE: string; TYPE_MESSAGE_DELETED: string; TYPE_MESSAGE_EDITED: string } = ...

Type declaration

  • TYPE_MEMBER_ADDED: string
  • TYPE_MEMBER_BANNED: string
  • TYPE_MEMBER_INVITED: string
  • TYPE_MEMBER_JOINED: string
  • TYPE_MEMBER_KICKED: string
  • TYPE_MEMBER_LEFT: string
  • TYPE_MEMBER_SCOPE_CHANGED: string
  • TYPE_MEMBER_UNBANNED: string
  • TYPE_MESSAGE: string
  • TYPE_MESSAGE_DELETED: string
  • TYPE_MESSAGE_EDITED: string

Static Readonly CATEGORY

CATEGORY: { ACTION: string; CALL: string; CUSTOM: string; MESSAGE: string } = ...

Type declaration

  • ACTION: string
  • CALL: string
  • CUSTOM: string
  • MESSAGE: string

Static Readonly RECEIVER_TYPE

RECEIVER_TYPE: { GROUP: string; USER: string } = ...

Type declaration

  • GROUP: string
  • USER: string

Static Readonly TYPE

TYPE: { AUDIO: string; CUSTOM: string; FILE: string; IMAGE: string; MEDIA: string; TEXT: string; VIDEO: string } = ...

Type declaration

  • AUDIO: string
  • CUSTOM: string
  • FILE: string
  • IMAGE: string
  • MEDIA: string
  • TEXT: string
  • VIDEO: string

Methods

getAction

  • getAction(): string

  • Get action of call.

    Returns string

getCallInitiator

  • getCallInitiator(): User

  • Get call initiator entity(User)

    Returns User

getCallReceiver

  • Get call receiver entity(User/Group)

    Returns Group | User

getCategory

  • getCategory(): MessageCategory

getConversationId

  • getConversationId(): string

getDeletedAt

  • getDeletedAt(): number

getDeletedBy

  • getDeletedBy(): string

getDeliveredAt

  • getDeliveredAt(): number

getDeliveredToMeAt

  • getDeliveredToMeAt(): number

getEditedAt

  • getEditedAt(): number

  • Get timestamp of the message when it was updated/edited.

    Returns number

getEditedBy

  • getEditedBy(): string

getId

  • getId(): number

getInitiatedAt

  • getInitiatedAt(): number

  • Get call initiated timestamp.

    Returns number

getJoinedAt

  • getJoinedAt(): number

  • Get call join timestamp.

    Returns number

getMetadata

  • getMetadata(): any

  • Get JSONObject of data set by developer.

    Returns any

getMuid

  • getMuid(): string

getParentMessageId

  • getParentMessageId(): number

getRawData

  • getRawData(): any

  • Get raw JSON data of the call message.

    Returns any

getRawMessage

  • getRawMessage(): Object

getReadAt

  • getReadAt(): number

getReadByMeAt

  • getReadByMeAt(): number

  • Get timestamp of the message at which it was read by the logged in user.

    Returns number

getReceiver

getReceiverId

  • getReceiverId(): string

getReceiverType

  • getReceiverType(): string

getReplyCount

  • getReplyCount(): number

getSender

getSentAt

  • getSentAt(): number

getSessionId

  • getSessionId(): string

  • Get unique session id of the call message.

    Returns string

getType

  • getType(): string

setAction

  • setAction(action: string): void

  • Parameters

    • action: string

      Set action of call.

    Returns void

setCallInitiator

  • setCallInitiator(user: User): void

  • Parameters

    • user: User

      Set details of the call initiator.

    Returns void

setCallReceiver

  • setCallReceiver(receiver: Group | User): void

  • Parameters

    • receiver: Group | User

      Set details of the call receiver.

    Returns void

setCategory

  • setCategory(category: MessageCategory): void

  • Parameters

    • category: MessageCategory

      Set category of the message.

    Returns void

setConversationId

  • setConversationId(value: string): void

setDeletedAt

  • setDeletedAt(deletedAt: number): void

  • Parameters

    • deletedAt: number

      Set timestamp of the message when it was deleted.

    Returns void

setDeletedBy

  • setDeletedBy(deletedBy: string): void

  • Parameters

    • deletedBy: string

      Set UID of the user who deleted the message.

    Returns void

setDeliveredAt

  • setDeliveredAt(deliveredAt: number): void

  • Parameters

    • deliveredAt: number

      Set delivery timestamp of the message.

    Returns void

setDeliveredToMeAt

  • setDeliveredToMeAt(deliveredToMeAt: number): void

  • Parameters

    • deliveredToMeAt: number

      Set timestamp of the message at which it was delivered to logged in user.

    Returns void

setEditedAt

  • setEditedAt(editedAt: number): void

  • Parameters

    • editedAt: number

      Set timestamp of the message when it was updated/edited.

    Returns void

setEditedBy

  • setEditedBy(editedBy: string): void

  • Parameters

    • editedBy: string

      Set UID of the user who edited/updated the message.

    Returns void

setId

  • setId(value: number): void

  • Parameters

    • value: number

      Set ID of the message

    Returns void

setInitiatedAt

  • setInitiatedAt(initiatedAt: number): void

  • Parameters

    • initiatedAt: number

      Set call initiated timestamp.

    Returns void

setJoinedAt

  • setJoinedAt(joinedAt: number): void

  • Parameters

    • joinedAt: number

      Set call join timestamp.

    Returns void

setMetadata

  • setMetadata(metadata: any): void

  • Parameters

    • metadata: any

      Set metadata of the call message.

    Returns void

setMuid

  • setMuid(value: string): void

  • Parameters

    • value: string

      Sets the MUID of the message.

    Returns void

setParentMessageId

  • setParentMessageId(value: number): void

setRawData

  • setRawData(rawData: any): void

  • Parameters

    • rawData: any

      Set raw JSON data of the call message.

    Returns void

setRawMessage

  • setRawMessage(rawMessage: Object): void

setReadAt

  • setReadAt(readAt: number): void

  • Parameters

    • readAt: number

      Set read timestamp of the message.

    Returns void

setReadByMeAt

  • setReadByMeAt(readByMeAt: number): void

  • Parameters

    • readByMeAt: number

      Set timestamp of the message at which it was read by the logged in user.

    Returns void

setReceiver

setReceiverId

  • setReceiverId(value: string): void

setReceiverType

  • setReceiverType(value: string): void

setReplyCount

  • setReplyCount(value: number): void

  • Parameters

    • value: number

      Set the number of replies of the message.

    Returns void

setSender

  • setSender(value: User): void

setSentAt

  • setSentAt(value: number): void

  • Parameters

    • value: number

      Set message's sentAt timestamp.

    Returns void

setSessionId

  • setSessionId(sessionId: string): void

  • Parameters

    • sessionId: string

      Set unique session id of the call message.

    Returns void

setType

  • setType(value: string): void

  • Parameters

    • value: string

      Set type of the message.

    Returns void