Messages

Overview

Players in a channel can exchange messages. At the same time, it is possible to implement sending a personal message, as well as messages to a feed or channel. Implemented methods that allow you to change and delete sent messages. Messages can also be used to send gifts to players or even turn-based battles.

This section covers methods for working with messages. The service allows you to send, change, delete messages and much more:

• gp.channels.sendMessage - sending the message to the channel
• gp.channels.sendPersonalMessage - sending a personal message to the player
• gp.channels.sendFeedMessage - sending a message to a feed
• gp.channels.editMessage - change the sent message
• gp.channels.deleteMessage - delete the sent message
• gp.channels.fetchMessages - get a list of messages in the selected channel
• gp.channels.fetchMoreMessages - additionally load messages in the channel
• gp.channels.fetchPersonalMessages - get a list of private messages
• gp.channels.fetchMorePersonalMessages - additional download private messages
• gp.channels.fetchFeedMessages - get a list of posts in a player's feed
• gp.channels.fetchMoreFeedMessages - additionally load messages in the feed

Sending a Message

To send a Hello! message to the channel channelId: 123, use the gp.channels.sendMessage method:

gp.channels.sendMessage({
  // Channel ID
  channelId: 123,
  // Message text
  text: 'Hello!',
  // Tags of messages for convenient filtration, optional
  tags: ['chat', 'trade'],
});

Sending a Private Message and to the Player's Feed

There is an option to send a private message to the player and send a message to the feed.

tip

Feed - a player's public channel, to which any member of the channel can send a message

To send a private message Hello! to the player playerId: 123456, use the method gp.channels.sendPersonalMessage:

gp.channels.sendPersonalMessage({
  // ID player
  playerId: 123,
  // Message text
  text: 'Hello!',
  // Tags of messages for convenient filtration, optional
  tags: ['chat', 'trade'],
});

To send a message to the feed gp.channels.sendFeedMessage:

gp.channels.sendFeedMessage({
  // ID player
  playerId: 123,
  // Message text
  text: 'Hello!',
  // Tags of messages for convenient filtration, optional
  tags: ['chat', 'trade'],
});

To get the result of the method call, you can subscribe to events:

gp.channels.on('sendMessage', (message) => {
  // Successfully sent

  // The ID of the post, it can be used to edit or delete the post
  message.id
  // Channel ID
  message.channelId
  // Post Author ID
  message.authorId
  // Message text
  message.text
  // Tags of messages
  message.tags
  // Public fields of the player - sender of messages
  message.player
  // Message sent time
  message.createdAt
});

Execution with an error:

gp.channels.on('error:sendMessage', (err) => {
  // Completed with an error
});

Possible errors are shown in the table below:

Basic Errors	Script Errors	Scripted only for sendMessage
player_not_found	empty_message	empty_channel_id
project_not_found	access_denied	channel_not_found
origin_not_allowed	message_characters_limit_exceeds
player_banned
internal_error

When a message is sent to all players in the channel, a notification of a new message is received:

gp.channels.on('event:message', (message) => {
    // Channel ID
    message.channelId;
    // ID messages
    message.id;
    // ID of the author of the message
    message.authorId;
    // Author's fields (avatar, name, custom fields)
    message.player;
    // Message text
    message.text;
    // Tags of messages
    message.tags;
    // The date of sending the message
    message.createdAt;
});

Edit Message

Changing the sent message is implemented using the gp.channels.editMessage method by the messageId identifier:

gp.channels.editMessage({ messageId: '638d73ee28520fc3b551a8ac', text: 'Hello!' });

To get the result of a method call, you can subscribe to events:

gp.channels.on('editMessage', (message) => {
  // Successfully updated

  // The ID of the post, it can be used to edit or delete the post
  message.id
  // Channel ID
  message.channelId
  // ID of the author of the message
  message.authorId
  // Message text
  message.text
  // Tags of messages
  message.tags
  // Player Public Fields - Sender of the Message
  message.player
  // The time of sending the message
  message.createdAt
});

Execution with an error:

gp.channels.on('error:editMessage', (err) => {
  // Completed with an error
});

Possible errors are shown in the table below:

Basic Errors	Script Errors
player_not_found	channel_message_not_found
project_not_found	empty_message
origin_not_allowed	access_denied
player_banned	message_characters_limit_exceeds
internal_error

When a message changes, all players in the channel receive a message change notification:

gp.channels.on('event:editMessage', (message) => {
    // Channel ID
    message.channelId;
    // ID messages
    message.id;
    // ID of the author of the message
    message.authorId;
    // Message text
    message.text;
    // Tags of messages
    message.tags;
    // The date of sending the message
    message.createdAt;
});

Deleting a Message

Deleting a sent message is implemented using the gp.channels.deleteMessage method by the messageId identifier:

gp.channels.deleteMessage({ messageId: '638d73ee28520fc3b551a8ac' });

To get the result of the method call, you can subscribe to events:

gp.channels.on('deleteMessage', () => {
  // Successfully deleted
});

Execution with an error:

gp.channels.on('error:deleteMessage', (err) => {
  // Completed with an error
});

Possible errors are shown in the table below:

Basic Errors	Script Errors
player_not_found	channel_message_not_found
project_not_found	access_denied
origin_not_allowed
player_banned
internal_error

When a message is deleted, all players in the channel receive a message deletion notification:

gp.channels.on('event:deleteMessage', (message) => {
    // Channel ID
    message.channelId;
    // ID messages
    message.id;
    // ID of the author of the message
    message.authorId;
    // Message text
    message.text;
    // Tags of messages
    message.tags;
    // The date of sending the message
    message.createdAt;
});

Get a List of Messages in the Selected Channel

tip

Mandatory access rights Allow to read messages

You can get a list of messages in the selected channel using the gp.channels.fetchMessages method:

const response = await gp.channels.fetchMessages({
  // Channel ID
  channelId: 123,
  // Tags of messages for filtering, through (&)
  tags: ['chat', 'trade'],
  // How much to request at a time, Max.100
  limit: 100,
  // How many records can be missed, Max.10,000, used for page navigation or "load more"
  offset: 0
});

Get a list of personal messages with another player:

const response = await gp.channels.fetchPersonalMessages({
  // ID of another player
  playerId: 123456,
  // Tags of messages for filtering, through (&)
  tags: ['chat', 'trade'],
  // How much to request at a time, Max.100
  limit: 100,
  // How many records can be missed, Max.10,000, used for page navigation or "load more"
  offset: 0
});

Get a list of posts in a player's feed:

const response = await gp.channels.fetchFeedMessages({
  // ID player
  playerId: 123456,
  // Tags of messages for filtering, through(&)
  tags: ['chat', 'trade'],
  // How much to request at a time, Max.100
  limit: 100,
  // How many records can be missed, Max.10,000, used for page navigation or "load more"
  offset: 0
});

To get the result of the method call, you can subscribe to events:

gp.channels.on('fetchMessages', (result) => {
  result.items // An array of the list of messages
  result.canLoadMore // Is it possible to load more messages

  result.items.forEach((message) => {
    // All posts of the message

    // ID messages, it can be used to edit or delete a message
    message.id
    // Channel ID
    message.channelId
    // ID Player - Author of Message
    message.authorId
    // Message text
    message.text
    // Tags of messages
    message.tags

    // Public fields of the author of the message
    message.player
    message.player.id
    message.player.name
    message.player.avatar
    // And other public fields

    // The date of creation of the message, ISO 8601
    message.createdAt
  });
});

Execution with an error:

gp.channels.on('error:fetchMessages', (err) => {
  // Completed with an error
});

Possible errors are shown in the table below:

Basic Errors	Script Errors
player_not_found	empty_channel_id
project_not_found	channel_not_found
origin_not_allowed	access_denied
player_banned
internal_error

To additionally fetch messages in a channel for the same request, there is a convenient gp.channels.fetchMoreMessages method:

const response = await gp.channels.fetchMoreMessages({
  // Channel ID
  channelId: 123,
  // Tags of messages for filtering, through (&)
  tags: ['chat', 'trade'],
  // How much to request at a time, Max.100
  limit: 100,
});

To additionally fetch personal messages for the same request, there is a convenient method gp.channels.fetchMorePersonalMessages:

const response = await gp.channels.fetchMorePersonalMessages({
  // ID of another player
  playerId: 123456,
  // Tags of messages for filtering, through (&)
  tags: ['chat', 'trade'],
  // How much to request at a time, Max.100
  limit: 100,
});

To additionally fetch messages in the feed for the same request, there is a convenient method gp.channels.fetchMoreFeedMessages:

const response = await gp.channels.fetchMoreFeedMessages({
  // ID player
  playerId: 123456,
  // Tags of messages for filtering, through (&)
  tags: ['chat', 'trade'],
  // How much to request at a time, Max.100
  limit: 100,
});

To get the result of the method call, you can subscribe to events:

gp.channels.on('fetchMoreMessages', (result) => {
  result.items //An array of the list of messages
  result.canLoadMore //Is it possible to load more messages
});

Execution with an error:

gp.channels.on('error:fetchMoreMessages', (err) => {
  // Completed with an error
});

Possible errors are shown in the table below:

Basic Errors	Script Errors
player_not_found	empty_channel_id
project_not_found	channel_not_found
origin_not_allowed	access_denied
player_banned
internal_error

Stay in Touch

Other documents of this chapter available Here. To get started, welcome to the Tutorials chapter.

GamePush Community Telegram: @gs_community.

For your suggestions e-mail: [email protected]

We Wish you Success!