Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessagesRequestBuilder

Hierarchy

  • MessagesRequestBuilder

Index

Constructors

constructor

Methods

build

  • This method will return an object of the MessagesRequest class.

    Returns MessagesRequest

hideDeletedMessages

hideMessagesFromBlockedUsers

  • Method to set parameters to hide or show message from blocked users.

    Parameters

    • hideMessagesFromBlockedUsers: boolean = false

    Returns MessagesRequestBuilder

hideReplies

setCategories

  • A method to set parameter to get the messages belonging to specific categories.

    Parameters

    • categories: String[]

    Returns MessagesRequestBuilder

setCategory

  • A method to set parameter to get the messages belonging to a specific category.

    Parameters

    • category: string

    Returns MessagesRequestBuilder

setGUID

  • A method to set GUID of a Group to get messages of that particular group conversation.

    Parameters

    • guid: string

    Returns MessagesRequestBuilder

setLimit

  • A method to set limit for the number of messages returned in a single iteration. A maximum of 100 messages can fetched in a single iteration.

    Parameters

    • limit: number

    Returns MessagesRequestBuilder

setMessageId

  • A method to set message ID of a particular message to get messages before/after the specified message.

    Parameters

    • id: number = ...

    Returns MessagesRequestBuilder

setParentMessageId

  • A method to set parent message id to get messages of that particular thread.

    Parameters

    • parentMessageId: number

    Returns MessagesRequestBuilder

setSearchKeyword

  • A method to set the search string based on which the messages are to be fetched.

    Parameters

    • searchKey: string

    Returns MessagesRequestBuilder

setTags

  • A method to set parameter to get the messages belonging to specific tags.

    Parameters

    • tags: String[]

    Returns MessagesRequestBuilder

setTimestamp

  • A method to set timestamp to get messages before/after the specified timestamp.

    Parameters

    • timestamp: number = ...

    Returns MessagesRequestBuilder

setType

  • A method to set parameter to get the messages belonging to a specific type.

    Parameters

    • type: string

    Returns MessagesRequestBuilder

setTypes

  • A method to set parameter to get the messages belonging to specific types.

    Parameters

    • types: String[]

    Returns MessagesRequestBuilder

setUID

  • A method to set UID of a User to get messages of that particular user conversation.

    Parameters

    • uid: string

    Returns MessagesRequestBuilder

setUnread

setUpdatedAfter

  • A method set timestamp to get fetch messages updated/edited after that timestamp.

    Parameters

    • updatedAt: string

    Returns MessagesRequestBuilder

updatesOnly

withTags