Contact
Newsletter
Schedule Consultation

Message

  • Unless stated otherwise, all objects are available in the following Across versions:
  • 5.7
  • 6.0
  • 6.3
  • 7.0
Tip

Function-specific return values are listed with each function.

For more information on return values and a complete list of error codes, see Function Return Types.

Function
Description
Makes it possible to send an Across message to a user registered in Across.
Makes it possible to send an Across message to all users currently logged in to Across.

Message.SendMessageTo

Makes it possible to send an Across message to a user registered in Across.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Msg
The message to be sent.
3
int
UserId
The ID of the user who is going to receive the message. Can be received via the functions ObjectManager.GetUserID and ObjectManager.GetUserIDByLogin.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
2
User does not exist.
Error
9
Unable to send message.

Message.SendMessageToAll

Makes it possible to send an Across message to all users currently logged in to Across.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Msg
The message to be sent.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
9
Unable to send message.