Type Alias UnionMessageReply

UnionMessageReply: GenericMessageReply & {
    cursor?: PaginationCursor;
    entries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | string[];
    entry?: MessagesReadReplyEntry & RecordsReadReplyEntry;
    subscription?: MessageSubscription;
}

Catch-all message reply type. It is recommended to use GenericMessageReply or a message-specific reply type wherever possible.

Type declaration

  • Optionalcursor?: PaginationCursor

    A cursor for pagination if applicable (e.g. RecordsQuery). Mutually exclusive with record.

  • Optionalentries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | string[]

    Resulting message entries or events returned from the invocation of the corresponding message. e.g. the resulting messages from a RecordsQuery, or array of messageCid strings for MessagesQuery Mutually exclusive with record.

  • Optionalentry?: MessagesReadReplyEntry & RecordsReadReplyEntry

    A container for the data returned from a RecordsRead or MessagesRead. Mutually exclusive with (entries + cursor) and subscription.

  • Optionalsubscription?: MessageSubscription

    A subscription object if a subscription was requested.

Settings

Member Visibility