@vonage/client-sdk - v2.7.0
    Preparing search index...

    Interface GetConversationEventsParameters

    Parameters object for VonageClient.getConversationEvents

    interface GetConversationEventsParameters {
        cursor?: Nullable<string>;
        eventFilter?: Nullable<string[]>;
        includeDeletedEvents?: Nullable<boolean>;
        order?: Nullable<PresentingOrder>;
        pageSize?: Nullable<number>;
        startId?: Nullable<number>;
    }
    Index
    cursor? eventFilter? includeDeletedEvents? order? pageSize? startId?
    cursor?: Nullable<string>

    The cursor indicating the starting point for pagination, default is the first page.

    eventFilter?: Nullable<string[]>

    A list of strings containing the types of events to be fetched and should have maximum 5 elements, default includes all events.

    includeDeletedEvents?: Nullable<boolean>

    Indicates whether to include deleted events in the list, default is false.

    order?: Nullable<PresentingOrder>

    The order in which conversation events are presented, default is PresentingOrder.ASC.

    pageSize?: Nullable<number>

    The maximum number of conversation events to retrieve per request, default is 10.

    startId?: Nullable<number>

    Specify the starting id of the events to be returned, default includes all events.

    Settings
    Member Visibility

    On This Page
    Properties