pl-api
    Preparing search index...

    Interface GetConversationsParams

    interface GetConversationsParams {
        language?: string;
        limit?: number;
        max_id?: string;
        min_id?: string;
        recipients?: string[];
        since_id?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    language? limit? max_id? min_id? recipients? since_id?

    Properties

    language?: string

    Fetch a translation in given language

    Requires features['fetchStatusesWithTranslation'].

    limit?: number

    Integer. Maximum number of results to return.

    max_id?: string

    String. All results returned will be lesser than this ID. In effect, sets an upper bound on results.

    min_id?: string

    String. Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward.

    recipients?: string[]

    Only return conversations with the given recipients (a list of user ids). Requires features['conversationsByRecipients'].

    since_id?: string

    String. All results returned will be greater than this ID. In effect, sets a lower bound on results.

    Settings

    Member Visibility

    On This Page

    Properties