Azure Connectors Node.js SDK
    Preparing search index...

    Interface GetAllMessagesOptions

    Options for the getAllMessages operation.

    interface GetAllMessagesOptions {
        abortSignal?: AbortSignalLike;
        limit?: number;
        networkId?: string;
        newerThan?: number;
        olderThan?: number;
        onResponse?: ConnectorRawResponseCallback;
        threaded?: string;
        tracingOptions?: OperationTracingOptions;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    limit?: number

    Return only the specified number of messages.

    networkId?: string

    Network ID

    newerThan?: number

    Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.

    olderThan?: number

    Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.

    Callback invoked with the complete response before the operation returns or throws.

    threaded?: string

    Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface.

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.