Class CharacterMessagesResource

Character messages resource

See

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

Hierarchy (View Summary)

BaseResource
- CharacterMessagesResource

Index

Constructors

Methods

create delete get list

Constructors

constructor

new CharacterMessagesResource(http: HttpClient): CharacterMessagesResource
Parameters
- http: HttpClient
Returns CharacterMessagesResource
Inherited from BaseResource.constructor
- Defined in src/resources/BaseResource.ts:13

Methods

create

create(options: CreateMessageOptions): Promise<Message>
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
Example
```
// Valid: handles
await client.character.messages.create({
  uid: '1:12345',
  receivers: 'recipient_handle_1;recipient_handle_2',
  communication: 'Hello from the SDK!'
});
```
Example
```
// 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'
});
```
- Defined in src/resources/CharacterResource.ts:170

delete

delete(options: DeleteMessageOptions): Promise<void>
Delete a message @requires_auth Yes @requires_scope MESSAGES_DELETE
Parameters
- options: DeleteMessageOptions
Returns Promise<void>
- Defined in src/resources/CharacterResource.ts:142

get

get(options: GetMessageOptions): Promise<Message>
Get a specific message @requires_auth Yes @requires_scope MESSAGES_READ
Parameters
- options: GetMessageOptions
  Character UID and message UID
  - messageId: string
  - uid: string
Returns Promise<Message>
Full message details including communication
Example
```
const messages = await client.character.messages.list({ uid: '1:12345', mode: 'received' });
const messageId = messages[0]?.attributes.uid;

if (messageId) {
  const message = await client.character.messages.get({ uid: '1:12345', messageId });
  console.log(message.communication);
}
```
- Defined in src/resources/CharacterResource.ts:133

list

list(options: ListMessagesOptions): Promise<MessageListItem[]>
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: 'sent' or 'received'. If omitted, returns both sent and received messages.
  - Optionalstart_index?: number
  - uid: string
Returns Promise<MessageListItem[]>
Array of message metadata items (MessageListItem[])
Example
```
const allMessages = await client.character.messages.list({ uid: '1:12345' });
const received = await client.character.messages.list({ uid: '1:12345', mode: 'received' });
const moreMessages = await client.character.messages.list({ uid: '1:12345', mode: 'received', start_index: 51, item_count: 50 });

const firstMessageId = received[0]?.attributes.uid;
if (firstMessageId) {
  const detail = await client.character.messages.get({ uid: '1:12345', messageId: firstMessageId });
  console.log(detail.communication);
}
```
- Defined in src/resources/CharacterResource.ts:99