SW Combine SDK
    Preparing search index...

    Class CharacterMessagesResource

    Character messages resource

    https://www.swcombine.com/ws/v2.0/documentation/character/uid/messages/mode/ SW Combine API Documentation

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    create delete get list

    Constructors

    Methods

    • Send a message @requires_auth Yes @requires_scope MESSAGES_SEND

      Parameters

      • options: CreateMessageOptions
        • communication: string

          Message text content

        • receivers: string

          Semicolon-separated list of recipient character handles (max 25). Example: 'handle1;handle2'

        • uid: string

      Returns Promise<Message>

      Message response typed as Message

      // Valid: handles
      await client.character.messages.create({
        uid: '1:12345',
        receivers: 'recipient_handle_1;recipient_handle_2',
        communication: 'Hello from the SDK!'
      });

      // Invalid: UIDs are rejected by the API and pre-validated by this SDK
      await client.character.messages.create({
        uid: '1:12345',
        receivers: '1:12345',
        communication: 'Test'
      });

    • Get a specific message @requires_auth Yes @requires_scope MESSAGES_READ

      Parameters

      Returns Promise<Message>

      Full message details including communication

      import { MessageMode } from 'swcombine-sdk';

      const messages = await client.character.messages.list({ uid: '1:12345', mode: MessageMode.Received });
      const messageId = messages.data[0]?.attributes.uid;

      if (messageId) {
        const message = await client.character.messages.get({ uid: '1:12345', messageId });
        console.log(message.communication);
      }

    • List messages sent or received by character (paginated)

      Note: list responses return MessageListItem[] metadata objects and do not guarantee a communication field. Use get() for full message content.

      @requires_auth Yes @requires_scope MESSAGES_READ

      Parameters

      • options: ListMessagesOptions

        Character UID, optional message mode, and optional pagination parameters

        • Optionalitem_count?: number
        • Optionalmode?: MessageMode

          Message mode: MessageMode.Sent or MessageMode.Received. If omitted, returns both sent and received messages.

        • OptionalpageDelay?: number

          Milliseconds to wait before fetching each subsequent page. Helps avoid rate limits during auto-pagination.

        • Optionalstart_index?: number
        • uid: string

      Returns Promise<Page<MessageListItem>>

      Page of message metadata items (Page<MessageListItem>)

      import { MessageMode } from 'swcombine-sdk';

      const allMessages = await client.character.messages.list({ uid: '1:12345' });
      const received = await client.character.messages.list({ uid: '1:12345', mode: MessageMode.Received });
      const moreMessages = await client.character.messages.list({ uid: '1:12345', mode: MessageMode.Received, start_index: 51, item_count: 50 });

      const firstMessageId = received.data[0]?.attributes.uid;
      if (firstMessageId) {
        const detail = await client.character.messages.get({ uid: '1:12345', messageId: firstMessageId });
        console.log(detail.communication);
      }

      // Iterate through all pages automatically
      for await (const msg of allMessages) {
        console.log(msg.attributes.uid);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods