@twilio/flex-sdk
    Preparing search index...

    Interface ReadQueryOptions<TData, TVariables>

    interface ReadQueryOptions<TData, TVariables extends OperationVariables> {
        id?: string;
        optimistic?: boolean;
        query: DocumentNode | TypedDocumentNode<TData, TVariables>;
        returnPartialData?: boolean;
        variables?: TVariables;
    }

    Type Parameters

    • TData
    • TVariables extends OperationVariables

    Hierarchy (View Summary)

    Index

    Properties

    id? optimistic? query returnPartialData? variables?

    Properties

    id?: string

    The root id to be used. Defaults to "ROOT_QUERY", which is the ID of the root query object. This property makes readQuery capable of reading data from any object in the cache.

    optimistic?: boolean

    Whether to read from optimistic or non-optimistic cache data. This option should be preferred over the optimistic parameter of the readQuery method.

    false
    query: DocumentNode | TypedDocumentNode<TData, TVariables>

    The GraphQL query shape to be used constructed using the gql template string tag. The query will be used to determine the shape of the data to be read.

    returnPartialData?: boolean

    Whether to return incomplete data rather than null.

    false
    variables?: TVariables

    Any variables that the GraphQL query may depend on.

    Settings

    Member Visibility

    On This Page

    Properties