Skip to main content

Get open channel history

Prerequisites

Retrieving remote open channel history requires the Open channel cloud message storage service. After activation, messages are stored in the cloud for 2 months by default.

Get messages

When leaving an open channel, local messages are cleared. After rejoining, use the channel's createOpenChannelMessagesQuery() to retrieve previous messages from the server.

Method

Dart
OpenChannelMessagesQuery createOpenChannelMessagesQuery(OpenChannelMessagesQueryParams params)

OpenChannelMessagesQueryParams

ParameterTypeDefaultDescription
channelIdStringRequiredOpen channel ID
orderTimeOrderTimeOrder.beforeDirection: before (descending) or after (ascending)
pageSizeint20Number of messages per page

Code example

Dart
final channel = OpenChannel('<open-channel-id>');
final query = channel.createOpenChannelMessagesQuery(
OpenChannelMessagesQueryParams(
channelId: '<open-channel-id>',
order: TimeOrder.before,
pageSize: 20,
),
);

await query.loadNextPage((result, error) {
if (error == null) {
print('Loaded ${result?.data.length} messages');
}
});

PageData<Message>

PropertyTypeDescription
dataList<Message>Messages returned in the current page.