SDKsHarmonyOSEnterprise

Create advanced text message

Create a text message containing entity spans and business link metadata.

Advanced text messages use MessageEntity to mark ranges within the body text, suitable for links, topics, or custom business entities. Entity offsets and lengths must match the character indexing rules used in text.

Code example

import sdk, {
  CreateAdvancedTextMessageReq,
  CreateAdvancedTextMessageResp,
  MessageEntity,
} from '@openimsdk/imsdk';

const entity: MessageEntity = {
  type: 'url',
  offset: 3,
  length: 4,
  url: 'https://example.com/releases',
  ex: '',
};
const request: CreateAdvancedTextMessageReq = {
  text: 'See release notes',
  messageEntities: [entity],
};
const response: CreateAdvancedTextMessageResp = await sdk.createAdvancedTextMessage(request);
const message = response.message;

Parameters

Parameter	Type	Required	Description
`text`	`string`	Yes	Message text content.
`messageEntities`	`MessageEntity[]`	Yes	List of entity metadata defining character spans within `text`.

Return value

Returns a Promise resolving to CreateAdvancedTextMessageResp:

Property	Type	Description
`message`	`IMMessage`	Locally instantiated message object.

State changes after the call

Receiving clients should verify that each entity span does not exceed string length boundaries, and validate URLs and extension data for security. Promise resolution confirms local message object creation without dispatching messages or opening URLs. Use Send message to send it.

Was this page helpful?