SDKsHarmonyOSEnterprise

Load message context

Retrieve surrounding chat messages before and after a specific anchor message.

When jumping into chat context from search results or replied quotes, use the complete fetched message as the anchor.

Code example

import sdk, {
  FetchSurroundingMessagesReq,
  FetchSurroundingMessagesResp,
  ViewType,
} from '@openimsdk/imsdk';

const request: FetchSurroundingMessagesReq = {
  startMessage: targetMessage,
  viewType: ViewType.ViewHistory,
  before: 20,
  after: 20,
};
const response: FetchSurroundingMessagesResp = await sdk.fetchSurroundingMessages(request);
renderMessages(response.messages);

Parameters

Parameter	Type	Required	Description
`startMessage`	`IMMessage`	Yes	Anchor message object around which surrounding history is retrieved.
`viewType`	`ViewType`	Yes	View mode, typically `ViewType.ViewHistory`.
`before`	`number`	Yes	Number of messages to retrieve chronologically before the anchor.
`after`	`number`	Yes	Number of messages to retrieve chronologically after the anchor.

Return value

Returns a Promise resolving to FetchSurroundingMessagesResp:

Property	Type	Description
`messages`	`IMMessage[]`	Array of chronologically ordered surrounding messages including the anchor.

Returned message counts may be fewer than before + after if the anchor is near timeline boundaries or if intermediate messages have been deleted. The anchor message must come from query results or message events; do not construct incomplete objects. When merging with existing lists, deduplicate by conversation context and clientMsgID. For ongoing pagination forward or backward, see Load older messages and Load newer messages.

Was this page helpful?

Code example

Parameters

Return value

State changes after the call