Get Message Context

Android
iOS
JavaScript
Flutter
ReactNative

Not supported.

Get message context: retrieves messages before and after a specified time so the application can display contextual messages. Use this API when first entering a conversation. To retrieve more message history downward or upward, use Get Message History.

Use Cases:

Enter a conversation, locate the first unread message, and display messages before and after it.

After searching messages, click a matched message to locate its conversation and display the context of that message.

Parameters

Name	Type	Required	Default	Description	Version
params	Object	Yes		Message history retrieval parameters	1.8.3
params.conversationType	Number	Yes		Conversation type	1.8.3
params.conversationId	String	Yes		Conversation ID. For `PRIVATE` conversations, it is the other user's userId; for `GROUP` conversations, it is the group ID.	1.8.3
params.time	Number	No	`time of the first unread message`	Start time for retrieving context messages	1.8.3
params.count	Number	No	10	Number of context messages to retrieve. Takes `count` messages before and after the specified `time` and returns them in `frontMessages` and `backMessages`. Range: 1–10.	1.8.3

Success Callback

Name	Type	Description	Version
result	Object		1.8.3
result.frontMessages	Array	Message array. See the Message structure for the properties of each message.	1.8.3
result.isFrontFinished	Boolean	Whether all earlier message history has been retrieved.	1.8.3
result.backMessages	Array	Message array. See the Message structure for the properties of each message.	1.8.3
result.isBackFinished	Boolean	Whether all later message history has been retrieved.	1.8.3

Failure Callback

Name	Type	Description	Version
error	Object	A status code is provided when sending fails. Check `error.msg` directly or see status codes.	1.8.3

Code Example

let { ConversationType } = JIM;

let params = {
  conversationType: ConversationType.PRIVATE,
  conversationId: 'userid2',
  count: 10
};

jim.getContextMessages(params).then((result) => {
  let { frontMessages, isFrontFinished, backMessages, isBackFinished } = result;
  console.log(result);
}, (error) => {
  console.log(error);
})