Chat / Flutter
Chat Flutter v3
Chat Flutter
Chat
Flutter
Version 3
Home
/
Chat
/
Flutter
/
Message

List all scheduled messages

Create a ScheduledMessageListQuery instance to retrieve all scheduled messages matching the specifications set by ScheduledMessageListQueryParams. After a list of all scheduled messages is successfully retrieved, you can access the data of each scheduled message from the result list through the messageList parameter of the callback handler.

final param = ScheduledMessageListParams();
final query = await ScheduledMessageListQuery(params: param).loadNext();
    // You can handle actions relevant to the scheduled message list of the channel.
}

ScheduledMessageListQueryParams

Property nameTypeDescription

order

ScheduledMessageListOrder

Determines the order of the retrieved messages. Acceptable values are created_at and scheduled_at. (Default: created_at)

messageType

MessageTypeFilter

Specifies the message type to filter the messages with the corresponding type. Acceptable values are all, user, file, and admin. (Default: all)

reverse

bool

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order. (Default: false)

channelUrl

String

Specifies a target channel to query the scheduled messages from. If null, it retrieves scheduled messages from all channels. (Default: null)

status

List

Specifies list of scheduled message status where scheduled messages with only given status are retrieved. (Default: null)

limit

int

Specifies the number of results to return per call. Acceptable values are 1 to 100, inclusive. (Default: 20)