This repository has been archived on 2023-04-11. You can view files and clone it, but cannot push or open issues or pull requests.
2020-08-15 17:42:49 -04:00

4351 lines
158 KiB
GDScript

### Code generated by codegen/main.go. DO NOT EDIT. ###
extends Reference
class_name NakamaAPI
# A single user-role pair.
class GroupUserListGroupUser extends NakamaAsyncResult:
const _SCHEMA = {
"state": {"name": "_state", "type": TYPE_INT, "required": false},
"user": {"name": "_user", "type": "ApiUser", "required": false},
}
# Their relationship to the group.
var state : int setget , _get_state
var _state = null
func _get_state() -> int:
return 0 if not _state is int else int(_state)
# User.
var user : ApiUser setget , _get_user
var _user = null
func _get_user() -> ApiUser:
return _user as ApiUser
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> GroupUserListGroupUser:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "GroupUserListGroupUser", p_dict), GroupUserListGroupUser) as GroupUserListGroupUser
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "state: %s, " % _state
output += "user: %s, " % _user
return output
# A single group-role pair.
class UserGroupListUserGroup extends NakamaAsyncResult:
const _SCHEMA = {
"group": {"name": "_group", "type": "ApiGroup", "required": false},
"state": {"name": "_state", "type": TYPE_INT, "required": false},
}
# Group.
var group : ApiGroup setget , _get_group
var _group = null
func _get_group() -> ApiGroup:
return _group as ApiGroup
# The user's relationship to the group.
var state : int setget , _get_state
var _state = null
func _get_state() -> int:
return 0 if not _state is int else int(_state)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> UserGroupListUserGroup:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "UserGroupListUserGroup", p_dict), UserGroupListUserGroup) as UserGroupListUserGroup
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "group: %s, " % _group
output += "state: %s, " % _state
return output
# Record values to write.
class WriteLeaderboardRecordRequestLeaderboardRecordWrite extends NakamaAsyncResult:
const _SCHEMA = {
"metadata": {"name": "_metadata", "type": TYPE_STRING, "required": false},
"score": {"name": "_score", "type": TYPE_STRING, "required": false},
"subscore": {"name": "_subscore", "type": TYPE_STRING, "required": false},
}
# Optional record metadata.
var metadata : String setget , _get_metadata
var _metadata = null
func _get_metadata() -> String:
return "" if not _metadata is String else String(_metadata)
# The score value to submit.
var score : String setget , _get_score
var _score = null
func _get_score() -> String:
return "" if not _score is String else String(_score)
# An optional secondary value.
var subscore : String setget , _get_subscore
var _subscore = null
func _get_subscore() -> String:
return "" if not _subscore is String else String(_subscore)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> WriteLeaderboardRecordRequestLeaderboardRecordWrite:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "WriteLeaderboardRecordRequestLeaderboardRecordWrite", p_dict), WriteLeaderboardRecordRequestLeaderboardRecordWrite) as WriteLeaderboardRecordRequestLeaderboardRecordWrite
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "metadata: %s, " % _metadata
output += "score: %s, " % _score
output += "subscore: %s, " % _subscore
return output
# Record values to write.
class WriteTournamentRecordRequestTournamentRecordWrite extends NakamaAsyncResult:
const _SCHEMA = {
"metadata": {"name": "_metadata", "type": TYPE_STRING, "required": false},
"score": {"name": "_score", "type": TYPE_STRING, "required": false},
"subscore": {"name": "_subscore", "type": TYPE_STRING, "required": false},
}
# A JSON object of additional properties (optional).
var metadata : String setget , _get_metadata
var _metadata = null
func _get_metadata() -> String:
return "" if not _metadata is String else String(_metadata)
# The score value to submit.
var score : String setget , _get_score
var _score = null
func _get_score() -> String:
return "" if not _score is String else String(_score)
# An optional secondary value.
var subscore : String setget , _get_subscore
var _subscore = null
func _get_subscore() -> String:
return "" if not _subscore is String else String(_subscore)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> WriteTournamentRecordRequestTournamentRecordWrite:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "WriteTournamentRecordRequestTournamentRecordWrite", p_dict), WriteTournamentRecordRequestTournamentRecordWrite) as WriteTournamentRecordRequestTournamentRecordWrite
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "metadata: %s, " % _metadata
output += "score: %s, " % _score
output += "subscore: %s, " % _subscore
return output
# A user with additional account details. Always the current user.
class ApiAccount extends NakamaAsyncResult:
const _SCHEMA = {
"custom_id": {"name": "_custom_id", "type": TYPE_STRING, "required": false},
"devices": {"name": "_devices", "type": TYPE_ARRAY, "required": false, "content": "ApiAccountDevice"},
"email": {"name": "_email", "type": TYPE_STRING, "required": false},
"user": {"name": "_user", "type": "ApiUser", "required": false},
"verify_time": {"name": "_verify_time", "type": TYPE_STRING, "required": false},
"wallet": {"name": "_wallet", "type": TYPE_STRING, "required": false},
}
# The custom id in the user's account.
var custom_id : String setget , _get_custom_id
var _custom_id = null
func _get_custom_id() -> String:
return "" if not _custom_id is String else String(_custom_id)
# The devices which belong to the user's account.
var devices : Array setget , _get_devices
var _devices = null
func _get_devices() -> Array:
return Array() if not _devices is Array else Array(_devices)
# The email address of the user.
var email : String setget , _get_email
var _email = null
func _get_email() -> String:
return "" if not _email is String else String(_email)
# The user object.
var user : ApiUser setget , _get_user
var _user = null
func _get_user() -> ApiUser:
return _user as ApiUser
# The UNIX time when the user's email was verified.
var verify_time : String setget , _get_verify_time
var _verify_time = null
func _get_verify_time() -> String:
return "" if not _verify_time is String else String(_verify_time)
# The user's wallet data.
var wallet : String setget , _get_wallet
var _wallet = null
func _get_wallet() -> String:
return "" if not _wallet is String else String(_wallet)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccount:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccount", p_dict), ApiAccount) as ApiAccount
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "custom_id: %s, " % _custom_id
output += "devices: %s, " % [_devices]
output += "email: %s, " % _email
output += "user: %s, " % _user
output += "verify_time: %s, " % _verify_time
output += "wallet: %s, " % _wallet
return output
# Send a custom ID to the server. Used with authenticate/link/unlink.
class ApiAccountCustom extends NakamaAsyncResult:
const _SCHEMA = {
"id": {"name": "_id", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
# A custom identifier.
var id : String setget , _get_id
var _id = null
func _get_id() -> String:
return "" if not _id is String else String(_id)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountCustom:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountCustom", p_dict), ApiAccountCustom) as ApiAccountCustom
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "id: %s, " % _id
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# Send a device to the server. Used with authenticate/link/unlink and user.
class ApiAccountDevice extends NakamaAsyncResult:
const _SCHEMA = {
"id": {"name": "_id", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
# A device identifier. Should be obtained by a platform-specific device API.
var id : String setget , _get_id
var _id = null
func _get_id() -> String:
return "" if not _id is String else String(_id)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountDevice:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountDevice", p_dict), ApiAccountDevice) as ApiAccountDevice
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "id: %s, " % _id
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# Send an email with password to the server. Used with authenticate/link/unlink.
class ApiAccountEmail extends NakamaAsyncResult:
const _SCHEMA = {
"email": {"name": "_email", "type": TYPE_STRING, "required": false},
"password": {"name": "_password", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
# A valid RFC-5322 email address.
var email : String setget , _get_email
var _email = null
func _get_email() -> String:
return "" if not _email is String else String(_email)
# A password for the user account.
var password : String setget , _get_password
var _password = null
func _get_password() -> String:
return "" if not _password is String else String(_password)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountEmail:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountEmail", p_dict), ApiAccountEmail) as ApiAccountEmail
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "email: %s, " % _email
output += "password: %s, " % _password
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# Send a Facebook token to the server. Used with authenticate/link/unlink.
class ApiAccountFacebook extends NakamaAsyncResult:
const _SCHEMA = {
"token": {"name": "_token", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
# The OAuth token received from Facebook to access their profile API.
var token : String setget , _get_token
var _token = null
func _get_token() -> String:
return "" if not _token is String else String(_token)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountFacebook:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountFacebook", p_dict), ApiAccountFacebook) as ApiAccountFacebook
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "token: %s, " % _token
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# Send a Facebook Instant Game token to the server. Used with authenticate/link/unlink.
class ApiAccountFacebookInstantGame extends NakamaAsyncResult:
const _SCHEMA = {
"signed_player_info": {"name": "_signed_player_info", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
#
var signed_player_info : String setget , _get_signed_player_info
var _signed_player_info = null
func _get_signed_player_info() -> String:
return "" if not _signed_player_info is String else String(_signed_player_info)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountFacebookInstantGame:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountFacebookInstantGame", p_dict), ApiAccountFacebookInstantGame) as ApiAccountFacebookInstantGame
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "signed_player_info: %s, " % _signed_player_info
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.
class ApiAccountGameCenter extends NakamaAsyncResult:
const _SCHEMA = {
"bundle_id": {"name": "_bundle_id", "type": TYPE_STRING, "required": false},
"player_id": {"name": "_player_id", "type": TYPE_STRING, "required": false},
"public_key_url": {"name": "_public_key_url", "type": TYPE_STRING, "required": false},
"salt": {"name": "_salt", "type": TYPE_STRING, "required": false},
"signature": {"name": "_signature", "type": TYPE_STRING, "required": false},
"timestamp_seconds": {"name": "_timestamp_seconds", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
# Bundle ID (generated by GameCenter).
var bundle_id : String setget , _get_bundle_id
var _bundle_id = null
func _get_bundle_id() -> String:
return "" if not _bundle_id is String else String(_bundle_id)
# Player ID (generated by GameCenter).
var player_id : String setget , _get_player_id
var _player_id = null
func _get_player_id() -> String:
return "" if not _player_id is String else String(_player_id)
# The URL for the public encryption key.
var public_key_url : String setget , _get_public_key_url
var _public_key_url = null
func _get_public_key_url() -> String:
return "" if not _public_key_url is String else String(_public_key_url)
# A random `NSString` used to compute the hash and keep it randomized.
var salt : String setget , _get_salt
var _salt = null
func _get_salt() -> String:
return "" if not _salt is String else String(_salt)
# The verification signature data generated.
var signature : String setget , _get_signature
var _signature = null
func _get_signature() -> String:
return "" if not _signature is String else String(_signature)
# Time since UNIX epoch when the signature was created.
var timestamp_seconds : String setget , _get_timestamp_seconds
var _timestamp_seconds = null
func _get_timestamp_seconds() -> String:
return "" if not _timestamp_seconds is String else String(_timestamp_seconds)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountGameCenter:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountGameCenter", p_dict), ApiAccountGameCenter) as ApiAccountGameCenter
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "bundle_id: %s, " % _bundle_id
output += "player_id: %s, " % _player_id
output += "public_key_url: %s, " % _public_key_url
output += "salt: %s, " % _salt
output += "signature: %s, " % _signature
output += "timestamp_seconds: %s, " % _timestamp_seconds
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# Send a Google token to the server. Used with authenticate/link/unlink.
class ApiAccountGoogle extends NakamaAsyncResult:
const _SCHEMA = {
"token": {"name": "_token", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
# The OAuth token received from Google to access their profile API.
var token : String setget , _get_token
var _token = null
func _get_token() -> String:
return "" if not _token is String else String(_token)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountGoogle:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountGoogle", p_dict), ApiAccountGoogle) as ApiAccountGoogle
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "token: %s, " % _token
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# Send a Steam token to the server. Used with authenticate/link/unlink.
class ApiAccountSteam extends NakamaAsyncResult:
const _SCHEMA = {
"token": {"name": "_token", "type": TYPE_STRING, "required": false},
"vars": {"name": "_vars", "type": TYPE_DICTIONARY, "required": false},
}
# The account token received from Steam to access their profile API.
var token : String setget , _get_token
var _token = null
func _get_token() -> String:
return "" if not _token is String else String(_token)
# Extra information that will be bundled in the session token.
var vars : Dictionary setget , _get_vars
var _vars = null
func _get_vars() -> Dictionary:
return Dictionary() if not _vars is Dictionary else _vars.duplicate()
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiAccountSteam:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiAccountSteam", p_dict), ApiAccountSteam) as ApiAccountSteam
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "token: %s, " % _token
var map_string : String = ""
if typeof(_vars) == TYPE_DICTIONARY:
for k in _vars:
map_string += "{%s=%s}, " % [k, _vars[k]]
output += "vars: [%s], " % map_string
return output
# A message sent on a channel.
class ApiChannelMessage extends NakamaAsyncResult:
const _SCHEMA = {
"channel_id": {"name": "_channel_id", "type": TYPE_STRING, "required": false},
"code": {"name": "_code", "type": TYPE_INT, "required": false},
"content": {"name": "_content", "type": TYPE_STRING, "required": false},
"create_time": {"name": "_create_time", "type": TYPE_STRING, "required": false},
"group_id": {"name": "_group_id", "type": TYPE_STRING, "required": false},
"message_id": {"name": "_message_id", "type": TYPE_STRING, "required": false},
"persistent": {"name": "_persistent", "type": TYPE_BOOL, "required": false},
"room_name": {"name": "_room_name", "type": TYPE_STRING, "required": false},
"sender_id": {"name": "_sender_id", "type": TYPE_STRING, "required": false},
"update_time": {"name": "_update_time", "type": TYPE_STRING, "required": false},
"user_id_one": {"name": "_user_id_one", "type": TYPE_STRING, "required": false},
"user_id_two": {"name": "_user_id_two", "type": TYPE_STRING, "required": false},
"username": {"name": "_username", "type": TYPE_STRING, "required": false},
}
# The channel this message belongs to.
var channel_id : String setget , _get_channel_id
var _channel_id = null
func _get_channel_id() -> String:
return "" if not _channel_id is String else String(_channel_id)
# The code representing a message type or category.
var code : int setget , _get_code
var _code = null
func _get_code() -> int:
return 0 if not _code is int else int(_code)
# The content payload.
var content : String setget , _get_content
var _content = null
func _get_content() -> String:
return "" if not _content is String else String(_content)
# The UNIX time when the message was created.
var create_time : String setget , _get_create_time
var _create_time = null
func _get_create_time() -> String:
return "" if not _create_time is String else String(_create_time)
# The ID of the group, or an empty string if this message was not sent through a group channel.
var group_id : String setget , _get_group_id
var _group_id = null
func _get_group_id() -> String:
return "" if not _group_id is String else String(_group_id)
# The unique ID of this message.
var message_id : String setget , _get_message_id
var _message_id = null
func _get_message_id() -> String:
return "" if not _message_id is String else String(_message_id)
# True if the message was persisted to the channel's history, false otherwise.
var persistent : bool setget , _get_persistent
var _persistent = null
func _get_persistent() -> bool:
return false if not _persistent is bool else bool(_persistent)
# The name of the chat room, or an empty string if this message was not sent through a chat room.
var room_name : String setget , _get_room_name
var _room_name = null
func _get_room_name() -> String:
return "" if not _room_name is String else String(_room_name)
# Message sender, usually a user ID.
var sender_id : String setget , _get_sender_id
var _sender_id = null
func _get_sender_id() -> String:
return "" if not _sender_id is String else String(_sender_id)
# The UNIX time when the message was last updated.
var update_time : String setget , _get_update_time
var _update_time = null
func _get_update_time() -> String:
return "" if not _update_time is String else String(_update_time)
# The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
var user_id_one : String setget , _get_user_id_one
var _user_id_one = null
func _get_user_id_one() -> String:
return "" if not _user_id_one is String else String(_user_id_one)
# The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
var user_id_two : String setget , _get_user_id_two
var _user_id_two = null
func _get_user_id_two() -> String:
return "" if not _user_id_two is String else String(_user_id_two)
# The username of the message sender, if any.
var username : String setget , _get_username
var _username = null
func _get_username() -> String:
return "" if not _username is String else String(_username)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiChannelMessage:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiChannelMessage", p_dict), ApiChannelMessage) as ApiChannelMessage
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "channel_id: %s, " % _channel_id
output += "code: %s, " % _code
output += "content: %s, " % _content
output += "create_time: %s, " % _create_time
output += "group_id: %s, " % _group_id
output += "message_id: %s, " % _message_id
output += "persistent: %s, " % _persistent
output += "room_name: %s, " % _room_name
output += "sender_id: %s, " % _sender_id
output += "update_time: %s, " % _update_time
output += "user_id_one: %s, " % _user_id_one
output += "user_id_two: %s, " % _user_id_two
output += "username: %s, " % _username
return output
# A list of channel messages, usually a result of a list operation.
class ApiChannelMessageList extends NakamaAsyncResult:
const _SCHEMA = {
"messages": {"name": "_messages", "type": TYPE_ARRAY, "required": false, "content": "ApiChannelMessage"},
"next_cursor": {"name": "_next_cursor", "type": TYPE_STRING, "required": false},
"prev_cursor": {"name": "_prev_cursor", "type": TYPE_STRING, "required": false},
}
# A list of messages.
var messages : Array setget , _get_messages
var _messages = null
func _get_messages() -> Array:
return Array() if not _messages is Array else Array(_messages)
# The cursor to send when retireving the next page, if any.
var next_cursor : String setget , _get_next_cursor
var _next_cursor = null
func _get_next_cursor() -> String:
return "" if not _next_cursor is String else String(_next_cursor)
# The cursor to send when retrieving the previous page, if any.
var prev_cursor : String setget , _get_prev_cursor
var _prev_cursor = null
func _get_prev_cursor() -> String:
return "" if not _prev_cursor is String else String(_prev_cursor)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiChannelMessageList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiChannelMessageList", p_dict), ApiChannelMessageList) as ApiChannelMessageList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "messages: %s, " % [_messages]
output += "next_cursor: %s, " % _next_cursor
output += "prev_cursor: %s, " % _prev_cursor
return output
# Create a group with the current user as owner.
class ApiCreateGroupRequest extends NakamaAsyncResult:
const _SCHEMA = {
"avatar_url": {"name": "_avatar_url", "type": TYPE_STRING, "required": false},
"description": {"name": "_description", "type": TYPE_STRING, "required": false},
"lang_tag": {"name": "_lang_tag", "type": TYPE_STRING, "required": false},
"max_count": {"name": "_max_count", "type": TYPE_INT, "required": false},
"name": {"name": "_name", "type": TYPE_STRING, "required": false},
"open": {"name": "_open", "type": TYPE_BOOL, "required": false},
}
# A URL for an avatar image.
var avatar_url : String setget , _get_avatar_url
var _avatar_url = null
func _get_avatar_url() -> String:
return "" if not _avatar_url is String else String(_avatar_url)
# A description for the group.
var description : String setget , _get_description
var _description = null
func _get_description() -> String:
return "" if not _description is String else String(_description)
# The language expected to be a tag which follows the BCP-47 spec.
var lang_tag : String setget , _get_lang_tag
var _lang_tag = null
func _get_lang_tag() -> String:
return "" if not _lang_tag is String else String(_lang_tag)
# Maximum number of group members.
var max_count : int setget , _get_max_count
var _max_count = null
func _get_max_count() -> int:
return 0 if not _max_count is int else int(_max_count)
# A unique name for the group.
var name : String setget , _get_name
var _name = null
func _get_name() -> String:
return "" if not _name is String else String(_name)
# Mark a group as open or not where only admins can accept members.
var open : bool setget , _get_open
var _open = null
func _get_open() -> bool:
return false if not _open is bool else bool(_open)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiCreateGroupRequest:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiCreateGroupRequest", p_dict), ApiCreateGroupRequest) as ApiCreateGroupRequest
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "avatar_url: %s, " % _avatar_url
output += "description: %s, " % _description
output += "lang_tag: %s, " % _lang_tag
output += "max_count: %s, " % _max_count
output += "name: %s, " % _name
output += "open: %s, " % _open
return output
# Storage objects to delete.
class ApiDeleteStorageObjectId extends NakamaAsyncResult:
const _SCHEMA = {
"collection": {"name": "_collection", "type": TYPE_STRING, "required": false},
"key": {"name": "_key", "type": TYPE_STRING, "required": false},
"version": {"name": "_version", "type": TYPE_STRING, "required": false},
}
# The collection which stores the object.
var collection : String setget , _get_collection
var _collection = null
func _get_collection() -> String:
return "" if not _collection is String else String(_collection)
# The key of the object within the collection.
var key : String setget , _get_key
var _key = null
func _get_key() -> String:
return "" if not _key is String else String(_key)
# The version hash of the object.
var version : String setget , _get_version
var _version = null
func _get_version() -> String:
return "" if not _version is String else String(_version)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiDeleteStorageObjectId:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiDeleteStorageObjectId", p_dict), ApiDeleteStorageObjectId) as ApiDeleteStorageObjectId
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "collection: %s, " % _collection
output += "key: %s, " % _key
output += "version: %s, " % _version
return output
# Batch delete storage objects.
class ApiDeleteStorageObjectsRequest extends NakamaAsyncResult:
const _SCHEMA = {
"object_ids": {"name": "_object_ids", "type": TYPE_ARRAY, "required": false, "content": "ApiDeleteStorageObjectId"},
}
# Batch of storage objects.
var object_ids : Array setget , _get_object_ids
var _object_ids = null
func _get_object_ids() -> Array:
return Array() if not _object_ids is Array else Array(_object_ids)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiDeleteStorageObjectsRequest:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiDeleteStorageObjectsRequest", p_dict), ApiDeleteStorageObjectsRequest) as ApiDeleteStorageObjectsRequest
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "object_ids: %s, " % [_object_ids]
return output
# Represents an event to be passed through the server to registered event handlers.
class ApiEvent extends NakamaAsyncResult:
const _SCHEMA = {
"external": {"name": "_external", "type": TYPE_BOOL, "required": false},
"name": {"name": "_name", "type": TYPE_STRING, "required": false},
"properties": {"name": "_properties", "type": TYPE_DICTIONARY, "required": false},
"timestamp": {"name": "_timestamp", "type": TYPE_STRING, "required": false},
}
# True if the event came directly from a client call, false otherwise.
var external : bool setget , _get_external
var _external = null
func _get_external() -> bool:
return false if not _external is bool else bool(_external)
# An event name, type, category, or identifier.
var name : String setget , _get_name
var _name = null
func _get_name() -> String:
return "" if not _name is String else String(_name)
# Arbitrary event property values.
var properties : Dictionary setget , _get_properties
var _properties = null
func _get_properties() -> Dictionary:
return Dictionary() if not _properties is Dictionary else _properties.duplicate()
# The time when the event was triggered.
var timestamp : String setget , _get_timestamp
var _timestamp = null
func _get_timestamp() -> String:
return "" if not _timestamp is String else String(_timestamp)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiEvent:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiEvent", p_dict), ApiEvent) as ApiEvent
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "external: %s, " % _external
output += "name: %s, " % _name
var map_string : String = ""
if typeof(_properties) == TYPE_DICTIONARY:
for k in _properties:
map_string += "{%s=%s}, " % [k, _properties[k]]
output += "properties: [%s], " % map_string
output += "timestamp: %s, " % _timestamp
return output
# A friend of a user.
class ApiFriend extends NakamaAsyncResult:
const _SCHEMA = {
"state": {"name": "_state", "type": TYPE_INT, "required": false},
"user": {"name": "_user", "type": "ApiUser", "required": false},
}
# The friend status.
var state : int setget , _get_state
var _state = null
func _get_state() -> int:
return 0 if not _state is int else int(_state)
# The user object.
var user : ApiUser setget , _get_user
var _user = null
func _get_user() -> ApiUser:
return _user as ApiUser
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiFriend:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiFriend", p_dict), ApiFriend) as ApiFriend
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "state: %s, " % _state
output += "user: %s, " % _user
return output
# A collection of zero or more friends of the user.
class ApiFriendList extends NakamaAsyncResult:
const _SCHEMA = {
"cursor": {"name": "_cursor", "type": TYPE_STRING, "required": false},
"friends": {"name": "_friends", "type": TYPE_ARRAY, "required": false, "content": "ApiFriend"},
}
# Cursor for the next page of results, if any.
var cursor : String setget , _get_cursor
var _cursor = null
func _get_cursor() -> String:
return "" if not _cursor is String else String(_cursor)
# The Friend objects.
var friends : Array setget , _get_friends
var _friends = null
func _get_friends() -> Array:
return Array() if not _friends is Array else Array(_friends)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiFriendList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiFriendList", p_dict), ApiFriendList) as ApiFriendList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "cursor: %s, " % _cursor
output += "friends: %s, " % [_friends]
return output
# A group in the server.
class ApiGroup extends NakamaAsyncResult:
const _SCHEMA = {
"avatar_url": {"name": "_avatar_url", "type": TYPE_STRING, "required": false},
"create_time": {"name": "_create_time", "type": TYPE_STRING, "required": false},
"creator_id": {"name": "_creator_id", "type": TYPE_STRING, "required": false},
"description": {"name": "_description", "type": TYPE_STRING, "required": false},
"edge_count": {"name": "_edge_count", "type": TYPE_INT, "required": false},
"id": {"name": "_id", "type": TYPE_STRING, "required": false},
"lang_tag": {"name": "_lang_tag", "type": TYPE_STRING, "required": false},
"max_count": {"name": "_max_count", "type": TYPE_INT, "required": false},
"metadata": {"name": "_metadata", "type": TYPE_STRING, "required": false},
"name": {"name": "_name", "type": TYPE_STRING, "required": false},
"open": {"name": "_open", "type": TYPE_BOOL, "required": false},
"update_time": {"name": "_update_time", "type": TYPE_STRING, "required": false},
}
# A URL for an avatar image.
var avatar_url : String setget , _get_avatar_url
var _avatar_url = null
func _get_avatar_url() -> String:
return "" if not _avatar_url is String else String(_avatar_url)
# The UNIX time when the group was created.
var create_time : String setget , _get_create_time
var _create_time = null
func _get_create_time() -> String:
return "" if not _create_time is String else String(_create_time)
# The id of the user who created the group.
var creator_id : String setget , _get_creator_id
var _creator_id = null
func _get_creator_id() -> String:
return "" if not _creator_id is String else String(_creator_id)
# A description for the group.
var description : String setget , _get_description
var _description = null
func _get_description() -> String:
return "" if not _description is String else String(_description)
# The current count of all members in the group.
var edge_count : int setget , _get_edge_count
var _edge_count = null
func _get_edge_count() -> int:
return 0 if not _edge_count is int else int(_edge_count)
# The id of a group.
var id : String setget , _get_id
var _id = null
func _get_id() -> String:
return "" if not _id is String else String(_id)
# The language expected to be a tag which follows the BCP-47 spec.
var lang_tag : String setget , _get_lang_tag
var _lang_tag = null
func _get_lang_tag() -> String:
return "" if not _lang_tag is String else String(_lang_tag)
# The maximum number of members allowed.
var max_count : int setget , _get_max_count
var _max_count = null
func _get_max_count() -> int:
return 0 if not _max_count is int else int(_max_count)
# Additional information stored as a JSON object.
var metadata : String setget , _get_metadata
var _metadata = null
func _get_metadata() -> String:
return "" if not _metadata is String else String(_metadata)
# The unique name of the group.
var name : String setget , _get_name
var _name = null
func _get_name() -> String:
return "" if not _name is String else String(_name)
# Anyone can join open groups, otherwise only admins can accept members.
var open : bool setget , _get_open
var _open = null
func _get_open() -> bool:
return false if not _open is bool else bool(_open)
# The UNIX time when the group was last updated.
var update_time : String setget , _get_update_time
var _update_time = null
func _get_update_time() -> String:
return "" if not _update_time is String else String(_update_time)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiGroup:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiGroup", p_dict), ApiGroup) as ApiGroup
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "avatar_url: %s, " % _avatar_url
output += "create_time: %s, " % _create_time
output += "creator_id: %s, " % _creator_id
output += "description: %s, " % _description
output += "edge_count: %s, " % _edge_count
output += "id: %s, " % _id
output += "lang_tag: %s, " % _lang_tag
output += "max_count: %s, " % _max_count
output += "metadata: %s, " % _metadata
output += "name: %s, " % _name
output += "open: %s, " % _open
output += "update_time: %s, " % _update_time
return output
# One or more groups returned from a listing operation.
class ApiGroupList extends NakamaAsyncResult:
const _SCHEMA = {
"cursor": {"name": "_cursor", "type": TYPE_STRING, "required": false},
"groups": {"name": "_groups", "type": TYPE_ARRAY, "required": false, "content": "ApiGroup"},
}
# A cursor used to get the next page.
var cursor : String setget , _get_cursor
var _cursor = null
func _get_cursor() -> String:
return "" if not _cursor is String else String(_cursor)
# One or more groups.
var groups : Array setget , _get_groups
var _groups = null
func _get_groups() -> Array:
return Array() if not _groups is Array else Array(_groups)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiGroupList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiGroupList", p_dict), ApiGroupList) as ApiGroupList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "cursor: %s, " % _cursor
output += "groups: %s, " % [_groups]
return output
# A list of users belonging to a group, along with their role.
class ApiGroupUserList extends NakamaAsyncResult:
const _SCHEMA = {
"cursor": {"name": "_cursor", "type": TYPE_STRING, "required": false},
"group_users": {"name": "_group_users", "type": TYPE_ARRAY, "required": false, "content": "GroupUserListGroupUser"},
}
# Cursor for the next page of results, if any.
var cursor : String setget , _get_cursor
var _cursor = null
func _get_cursor() -> String:
return "" if not _cursor is String else String(_cursor)
# User-role pairs for a group.
var group_users : Array setget , _get_group_users
var _group_users = null
func _get_group_users() -> Array:
return Array() if not _group_users is Array else Array(_group_users)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiGroupUserList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiGroupUserList", p_dict), ApiGroupUserList) as ApiGroupUserList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "cursor: %s, " % _cursor
output += "group_users: %s, " % [_group_users]
return output
# Represents a complete leaderboard record with all scores and associated metadata.
class ApiLeaderboardRecord extends NakamaAsyncResult:
const _SCHEMA = {
"create_time": {"name": "_create_time", "type": TYPE_STRING, "required": false},
"expiry_time": {"name": "_expiry_time", "type": TYPE_STRING, "required": false},
"leaderboard_id": {"name": "_leaderboard_id", "type": TYPE_STRING, "required": false},
"max_num_score": {"name": "_max_num_score", "type": TYPE_INT, "required": false},
"metadata": {"name": "_metadata", "type": TYPE_STRING, "required": false},
"num_score": {"name": "_num_score", "type": TYPE_INT, "required": false},
"owner_id": {"name": "_owner_id", "type": TYPE_STRING, "required": false},
"rank": {"name": "_rank", "type": TYPE_STRING, "required": false},
"score": {"name": "_score", "type": TYPE_STRING, "required": false},
"subscore": {"name": "_subscore", "type": TYPE_STRING, "required": false},
"update_time": {"name": "_update_time", "type": TYPE_STRING, "required": false},
"username": {"name": "_username", "type": TYPE_STRING, "required": false},
}
# The UNIX time when the leaderboard record was created.
var create_time : String setget , _get_create_time
var _create_time = null
func _get_create_time() -> String:
return "" if not _create_time is String else String(_create_time)
# The UNIX time when the leaderboard record expires.
var expiry_time : String setget , _get_expiry_time
var _expiry_time = null
func _get_expiry_time() -> String:
return "" if not _expiry_time is String else String(_expiry_time)
# The ID of the leaderboard this score belongs to.
var leaderboard_id : String setget , _get_leaderboard_id
var _leaderboard_id = null
func _get_leaderboard_id() -> String:
return "" if not _leaderboard_id is String else String(_leaderboard_id)
# The maximum number of score updates allowed by the owner.
var max_num_score : int setget , _get_max_num_score
var _max_num_score = null
func _get_max_num_score() -> int:
return 0 if not _max_num_score is int else int(_max_num_score)
# Metadata.
var metadata : String setget , _get_metadata
var _metadata = null
func _get_metadata() -> String:
return "" if not _metadata is String else String(_metadata)
# The number of submissions to this score record.
var num_score : int setget , _get_num_score
var _num_score = null
func _get_num_score() -> int:
return 0 if not _num_score is int else int(_num_score)
# The ID of the score owner, usually a user or group.
var owner_id : String setget , _get_owner_id
var _owner_id = null
func _get_owner_id() -> String:
return "" if not _owner_id is String else String(_owner_id)
# The rank of this record.
var rank : String setget , _get_rank
var _rank = null
func _get_rank() -> String:
return "" if not _rank is String else String(_rank)
# The score value.
var score : String setget , _get_score
var _score = null
func _get_score() -> String:
return "" if not _score is String else String(_score)
# An optional subscore value.
var subscore : String setget , _get_subscore
var _subscore = null
func _get_subscore() -> String:
return "" if not _subscore is String else String(_subscore)
# The UNIX time when the leaderboard record was updated.
var update_time : String setget , _get_update_time
var _update_time = null
func _get_update_time() -> String:
return "" if not _update_time is String else String(_update_time)
# The username of the score owner, if the owner is a user.
var username : String setget , _get_username
var _username = null
func _get_username() -> String:
return "" if not _username is String else String(_username)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiLeaderboardRecord:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiLeaderboardRecord", p_dict), ApiLeaderboardRecord) as ApiLeaderboardRecord
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "create_time: %s, " % _create_time
output += "expiry_time: %s, " % _expiry_time
output += "leaderboard_id: %s, " % _leaderboard_id
output += "max_num_score: %s, " % _max_num_score
output += "metadata: %s, " % _metadata
output += "num_score: %s, " % _num_score
output += "owner_id: %s, " % _owner_id
output += "rank: %s, " % _rank
output += "score: %s, " % _score
output += "subscore: %s, " % _subscore
output += "update_time: %s, " % _update_time
output += "username: %s, " % _username
return output
# A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
class ApiLeaderboardRecordList extends NakamaAsyncResult:
const _SCHEMA = {
"next_cursor": {"name": "_next_cursor", "type": TYPE_STRING, "required": false},
"owner_records": {"name": "_owner_records", "type": TYPE_ARRAY, "required": false, "content": "ApiLeaderboardRecord"},
"prev_cursor": {"name": "_prev_cursor", "type": TYPE_STRING, "required": false},
"records": {"name": "_records", "type": TYPE_ARRAY, "required": false, "content": "ApiLeaderboardRecord"},
}
# The cursor to send when retrieving the next page, if any.
var next_cursor : String setget , _get_next_cursor
var _next_cursor = null
func _get_next_cursor() -> String:
return "" if not _next_cursor is String else String(_next_cursor)
# A batched set of leaderboard records belonging to specified owners.
var owner_records : Array setget , _get_owner_records
var _owner_records = null
func _get_owner_records() -> Array:
return Array() if not _owner_records is Array else Array(_owner_records)
# The cursor to send when retrieving the previous page, if any.
var prev_cursor : String setget , _get_prev_cursor
var _prev_cursor = null
func _get_prev_cursor() -> String:
return "" if not _prev_cursor is String else String(_prev_cursor)
# A list of leaderboard records.
var records : Array setget , _get_records
var _records = null
func _get_records() -> Array:
return Array() if not _records is Array else Array(_records)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiLeaderboardRecordList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiLeaderboardRecordList", p_dict), ApiLeaderboardRecordList) as ApiLeaderboardRecordList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "next_cursor: %s, " % _next_cursor
output += "owner_records: %s, " % [_owner_records]
output += "prev_cursor: %s, " % _prev_cursor
output += "records: %s, " % [_records]
return output
# Represents a realtime match.
class ApiMatch extends NakamaAsyncResult:
const _SCHEMA = {
"authoritative": {"name": "_authoritative", "type": TYPE_BOOL, "required": false},
"label": {"name": "_label", "type": TYPE_STRING, "required": false},
"match_id": {"name": "_match_id", "type": TYPE_STRING, "required": false},
"size": {"name": "_size", "type": TYPE_INT, "required": false},
}
# True if it's an server-managed authoritative match, false otherwise.
var authoritative : bool setget , _get_authoritative
var _authoritative = null
func _get_authoritative() -> bool:
return false if not _authoritative is bool else bool(_authoritative)
# Match label, if any.
var label : String setget , _get_label
var _label = null
func _get_label() -> String:
return "" if not _label is String else String(_label)
# The ID of the match, can be used to join.
var match_id : String setget , _get_match_id
var _match_id = null
func _get_match_id() -> String:
return "" if not _match_id is String else String(_match_id)
# Current number of users in the match.
var size : int setget , _get_size
var _size = null
func _get_size() -> int:
return 0 if not _size is int else int(_size)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiMatch:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiMatch", p_dict), ApiMatch) as ApiMatch
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "authoritative: %s, " % _authoritative
output += "label: %s, " % _label
output += "match_id: %s, " % _match_id
output += "size: %s, " % _size
return output
# A list of realtime matches.
class ApiMatchList extends NakamaAsyncResult:
const _SCHEMA = {
"matches": {"name": "_matches", "type": TYPE_ARRAY, "required": false, "content": "ApiMatch"},
}
# A number of matches corresponding to a list operation.
var matches : Array setget , _get_matches
var _matches = null
func _get_matches() -> Array:
return Array() if not _matches is Array else Array(_matches)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiMatchList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiMatchList", p_dict), ApiMatchList) as ApiMatchList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "matches: %s, " % [_matches]
return output
# A notification in the server.
class ApiNotification extends NakamaAsyncResult:
const _SCHEMA = {
"code": {"name": "_code", "type": TYPE_INT, "required": false},
"content": {"name": "_content", "type": TYPE_STRING, "required": false},
"create_time": {"name": "_create_time", "type": TYPE_STRING, "required": false},
"id": {"name": "_id", "type": TYPE_STRING, "required": false},
"persistent": {"name": "_persistent", "type": TYPE_BOOL, "required": false},
"sender_id": {"name": "_sender_id", "type": TYPE_STRING, "required": false},
"subject": {"name": "_subject", "type": TYPE_STRING, "required": false},
}
# Category code for this notification.
var code : int setget , _get_code
var _code = null
func _get_code() -> int:
return 0 if not _code is int else int(_code)
# Content of the notification in JSON.
var content : String setget , _get_content
var _content = null
func _get_content() -> String:
return "" if not _content is String else String(_content)
# The UNIX time when the notification was created.
var create_time : String setget , _get_create_time
var _create_time = null
func _get_create_time() -> String:
return "" if not _create_time is String else String(_create_time)
# ID of the Notification.
var id : String setget , _get_id
var _id = null
func _get_id() -> String:
return "" if not _id is String else String(_id)
# True if this notification was persisted to the database.
var persistent : bool setget , _get_persistent
var _persistent = null
func _get_persistent() -> bool:
return false if not _persistent is bool else bool(_persistent)
# ID of the sender, if a user. Otherwise `null`.
var sender_id : String setget , _get_sender_id
var _sender_id = null
func _get_sender_id() -> String:
return "" if not _sender_id is String else String(_sender_id)
# Subject of the notification.
var subject : String setget , _get_subject
var _subject = null
func _get_subject() -> String:
return "" if not _subject is String else String(_subject)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiNotification:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiNotification", p_dict), ApiNotification) as ApiNotification
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "code: %s, " % _code
output += "content: %s, " % _content
output += "create_time: %s, " % _create_time
output += "id: %s, " % _id
output += "persistent: %s, " % _persistent
output += "sender_id: %s, " % _sender_id
output += "subject: %s, " % _subject
return output
# A collection of zero or more notifications.
class ApiNotificationList extends NakamaAsyncResult:
const _SCHEMA = {
"cacheable_cursor": {"name": "_cacheable_cursor", "type": TYPE_STRING, "required": false},
"notifications": {"name": "_notifications", "type": TYPE_ARRAY, "required": false, "content": "ApiNotification"},
}
# Use this cursor to paginate notifications. Cache this to catch up to new notifications.
var cacheable_cursor : String setget , _get_cacheable_cursor
var _cacheable_cursor = null
func _get_cacheable_cursor() -> String:
return "" if not _cacheable_cursor is String else String(_cacheable_cursor)
# Collection of notifications.
var notifications : Array setget , _get_notifications
var _notifications = null
func _get_notifications() -> Array:
return Array() if not _notifications is Array else Array(_notifications)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiNotificationList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiNotificationList", p_dict), ApiNotificationList) as ApiNotificationList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "cacheable_cursor: %s, " % _cacheable_cursor
output += "notifications: %s, " % [_notifications]
return output
# Storage objects to get.
class ApiReadStorageObjectId extends NakamaAsyncResult:
const _SCHEMA = {
"collection": {"name": "_collection", "type": TYPE_STRING, "required": false},
"key": {"name": "_key", "type": TYPE_STRING, "required": false},
"user_id": {"name": "_user_id", "type": TYPE_STRING, "required": false},
}
# The collection which stores the object.
var collection : String setget , _get_collection
var _collection = null
func _get_collection() -> String:
return "" if not _collection is String else String(_collection)
# The key of the object within the collection.
var key : String setget , _get_key
var _key = null
func _get_key() -> String:
return "" if not _key is String else String(_key)
# The user owner of the object.
var user_id : String setget , _get_user_id
var _user_id = null
func _get_user_id() -> String:
return "" if not _user_id is String else String(_user_id)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiReadStorageObjectId:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiReadStorageObjectId", p_dict), ApiReadStorageObjectId) as ApiReadStorageObjectId
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "collection: %s, " % _collection
output += "key: %s, " % _key
output += "user_id: %s, " % _user_id
return output
# Batch get storage objects.
class ApiReadStorageObjectsRequest extends NakamaAsyncResult:
const _SCHEMA = {
"object_ids": {"name": "_object_ids", "type": TYPE_ARRAY, "required": false, "content": "ApiReadStorageObjectId"},
}
# Batch of storage objects.
var object_ids : Array setget , _get_object_ids
var _object_ids = null
func _get_object_ids() -> Array:
return Array() if not _object_ids is Array else Array(_object_ids)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiReadStorageObjectsRequest:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiReadStorageObjectsRequest", p_dict), ApiReadStorageObjectsRequest) as ApiReadStorageObjectsRequest
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "object_ids: %s, " % [_object_ids]
return output
# Execute an Lua function on the server.
class ApiRpc extends NakamaAsyncResult:
const _SCHEMA = {
"http_key": {"name": "_http_key", "type": TYPE_STRING, "required": false},
"id": {"name": "_id", "type": TYPE_STRING, "required": false},
"payload": {"name": "_payload", "type": TYPE_STRING, "required": false},
}
# The authentication key used when executed as a non-client HTTP request.
var http_key : String setget , _get_http_key
var _http_key = null
func _get_http_key() -> String:
return "" if not _http_key is String else String(_http_key)
# The identifier of the function.
var id : String setget , _get_id
var _id = null
func _get_id() -> String:
return "" if not _id is String else String(_id)
# The payload of the function which must be a JSON object.
var payload : String setget , _get_payload
var _payload = null
func _get_payload() -> String:
return "" if not _payload is String else String(_payload)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiRpc:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiRpc", p_dict), ApiRpc) as ApiRpc
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "http_key: %s, " % _http_key
output += "id: %s, " % _id
output += "payload: %s, " % _payload
return output
# A user's session used to authenticate messages.
class ApiSession extends NakamaAsyncResult:
const _SCHEMA = {
"created": {"name": "_created", "type": TYPE_BOOL, "required": false},
"token": {"name": "_token", "type": TYPE_STRING, "required": false},
}
# True if the corresponding account was just created, false otherwise.
var created : bool setget , _get_created
var _created = null
func _get_created() -> bool:
return false if not _created is bool else bool(_created)
# Authentication credentials.
var token : String setget , _get_token
var _token = null
func _get_token() -> String:
return "" if not _token is String else String(_token)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiSession:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiSession", p_dict), ApiSession) as ApiSession
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "created: %s, " % _created
output += "token: %s, " % _token
return output
# An object within the storage engine.
class ApiStorageObject extends NakamaAsyncResult:
const _SCHEMA = {
"collection": {"name": "_collection", "type": TYPE_STRING, "required": false},
"create_time": {"name": "_create_time", "type": TYPE_STRING, "required": false},
"key": {"name": "_key", "type": TYPE_STRING, "required": false},
"permission_read": {"name": "_permission_read", "type": TYPE_INT, "required": false},
"permission_write": {"name": "_permission_write", "type": TYPE_INT, "required": false},
"update_time": {"name": "_update_time", "type": TYPE_STRING, "required": false},
"user_id": {"name": "_user_id", "type": TYPE_STRING, "required": false},
"value": {"name": "_value", "type": TYPE_STRING, "required": false},
"version": {"name": "_version", "type": TYPE_STRING, "required": false},
}
# The collection which stores the object.
var collection : String setget , _get_collection
var _collection = null
func _get_collection() -> String:
return "" if not _collection is String else String(_collection)
# The UNIX time when the object was created.
var create_time : String setget , _get_create_time
var _create_time = null
func _get_create_time() -> String:
return "" if not _create_time is String else String(_create_time)
# The key of the object within the collection.
var key : String setget , _get_key
var _key = null
func _get_key() -> String:
return "" if not _key is String else String(_key)
# The read access permissions for the object.
var permission_read : int setget , _get_permission_read
var _permission_read = null
func _get_permission_read() -> int:
return 0 if not _permission_read is int else int(_permission_read)
# The write access permissions for the object.
var permission_write : int setget , _get_permission_write
var _permission_write = null
func _get_permission_write() -> int:
return 0 if not _permission_write is int else int(_permission_write)
# The UNIX time when the object was last updated.
var update_time : String setget , _get_update_time
var _update_time = null
func _get_update_time() -> String:
return "" if not _update_time is String else String(_update_time)
# The user owner of the object.
var user_id : String setget , _get_user_id
var _user_id = null
func _get_user_id() -> String:
return "" if not _user_id is String else String(_user_id)
# The value of the object.
var value : String setget , _get_value
var _value = null
func _get_value() -> String:
return "" if not _value is String else String(_value)
# The version hash of the object.
var version : String setget , _get_version
var _version = null
func _get_version() -> String:
return "" if not _version is String else String(_version)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiStorageObject:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiStorageObject", p_dict), ApiStorageObject) as ApiStorageObject
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "collection: %s, " % _collection
output += "create_time: %s, " % _create_time
output += "key: %s, " % _key
output += "permission_read: %s, " % _permission_read
output += "permission_write: %s, " % _permission_write
output += "update_time: %s, " % _update_time
output += "user_id: %s, " % _user_id
output += "value: %s, " % _value
output += "version: %s, " % _version
return output
# A storage acknowledgement.
class ApiStorageObjectAck extends NakamaAsyncResult:
const _SCHEMA = {
"collection": {"name": "_collection", "type": TYPE_STRING, "required": false},
"key": {"name": "_key", "type": TYPE_STRING, "required": false},
"user_id": {"name": "_user_id", "type": TYPE_STRING, "required": false},
"version": {"name": "_version", "type": TYPE_STRING, "required": false},
}
# The collection which stores the object.
var collection : String setget , _get_collection
var _collection = null
func _get_collection() -> String:
return "" if not _collection is String else String(_collection)
# The key of the object within the collection.
var key : String setget , _get_key
var _key = null
func _get_key() -> String:
return "" if not _key is String else String(_key)
# The owner of the object.
var user_id : String setget , _get_user_id
var _user_id = null
func _get_user_id() -> String:
return "" if not _user_id is String else String(_user_id)
# The version hash of the object.
var version : String setget , _get_version
var _version = null
func _get_version() -> String:
return "" if not _version is String else String(_version)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiStorageObjectAck:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiStorageObjectAck", p_dict), ApiStorageObjectAck) as ApiStorageObjectAck
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "collection: %s, " % _collection
output += "key: %s, " % _key
output += "user_id: %s, " % _user_id
output += "version: %s, " % _version
return output
# Batch of acknowledgements for the storage object write.
class ApiStorageObjectAcks extends NakamaAsyncResult:
const _SCHEMA = {
"acks": {"name": "_acks", "type": TYPE_ARRAY, "required": false, "content": "ApiStorageObjectAck"},
}
# Batch of storage write acknowledgements.
var acks : Array setget , _get_acks
var _acks = null
func _get_acks() -> Array:
return Array() if not _acks is Array else Array(_acks)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiStorageObjectAcks:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiStorageObjectAcks", p_dict), ApiStorageObjectAcks) as ApiStorageObjectAcks
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "acks: %s, " % [_acks]
return output
# List of storage objects.
class ApiStorageObjectList extends NakamaAsyncResult:
const _SCHEMA = {
"cursor": {"name": "_cursor", "type": TYPE_STRING, "required": false},
"objects": {"name": "_objects", "type": TYPE_ARRAY, "required": false, "content": "ApiStorageObject"},
}
# The cursor for the next page of results, if any.
var cursor : String setget , _get_cursor
var _cursor = null
func _get_cursor() -> String:
return "" if not _cursor is String else String(_cursor)
# The list of storage objects.
var objects : Array setget , _get_objects
var _objects = null
func _get_objects() -> Array:
return Array() if not _objects is Array else Array(_objects)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiStorageObjectList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiStorageObjectList", p_dict), ApiStorageObjectList) as ApiStorageObjectList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "cursor: %s, " % _cursor
output += "objects: %s, " % [_objects]
return output
# Batch of storage objects.
class ApiStorageObjects extends NakamaAsyncResult:
const _SCHEMA = {
"objects": {"name": "_objects", "type": TYPE_ARRAY, "required": false, "content": "ApiStorageObject"},
}
# The batch of storage objects.
var objects : Array setget , _get_objects
var _objects = null
func _get_objects() -> Array:
return Array() if not _objects is Array else Array(_objects)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiStorageObjects:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiStorageObjects", p_dict), ApiStorageObjects) as ApiStorageObjects
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "objects: %s, " % [_objects]
return output
# A tournament on the server.
class ApiTournament extends NakamaAsyncResult:
const _SCHEMA = {
"can_enter": {"name": "_can_enter", "type": TYPE_BOOL, "required": false},
"category": {"name": "_category", "type": TYPE_INT, "required": false},
"create_time": {"name": "_create_time", "type": TYPE_STRING, "required": false},
"description": {"name": "_description", "type": TYPE_STRING, "required": false},
"duration": {"name": "_duration", "type": TYPE_INT, "required": false},
"end_active": {"name": "_end_active", "type": TYPE_INT, "required": false},
"end_time": {"name": "_end_time", "type": TYPE_STRING, "required": false},
"id": {"name": "_id", "type": TYPE_STRING, "required": false},
"max_num_score": {"name": "_max_num_score", "type": TYPE_INT, "required": false},
"max_size": {"name": "_max_size", "type": TYPE_INT, "required": false},
"metadata": {"name": "_metadata", "type": TYPE_STRING, "required": false},
"next_reset": {"name": "_next_reset", "type": TYPE_INT, "required": false},
"size": {"name": "_size", "type": TYPE_INT, "required": false},
"sort_order": {"name": "_sort_order", "type": TYPE_INT, "required": false},
"start_active": {"name": "_start_active", "type": TYPE_INT, "required": false},
"start_time": {"name": "_start_time", "type": TYPE_STRING, "required": false},
"title": {"name": "_title", "type": TYPE_STRING, "required": false},
}
# True if the tournament is active and can enter. A computed value.
var can_enter : bool setget , _get_can_enter
var _can_enter = null
func _get_can_enter() -> bool:
return false if not _can_enter is bool else bool(_can_enter)
# The category of the tournament. e.g. "vip" could be category 1.
var category : int setget , _get_category
var _category = null
func _get_category() -> int:
return 0 if not _category is int else int(_category)
# The UNIX time when the tournament was created.
var create_time : String setget , _get_create_time
var _create_time = null
func _get_create_time() -> String:
return "" if not _create_time is String else String(_create_time)
# The description of the tournament. May be blank.
var description : String setget , _get_description
var _description = null
func _get_description() -> String:
return "" if not _description is String else String(_description)
# Duration of the tournament in seconds.
var duration : int setget , _get_duration
var _duration = null
func _get_duration() -> int:
return 0 if not _duration is int else int(_duration)
# The UNIX time when the tournament stops being active until next reset. A computed value.
var end_active : int setget , _get_end_active
var _end_active = null
func _get_end_active() -> int:
return 0 if not _end_active is int else int(_end_active)
# The UNIX time when the tournament will be stopped.
var end_time : String setget , _get_end_time
var _end_time = null
func _get_end_time() -> String:
return "" if not _end_time is String else String(_end_time)
# The ID of the tournament.
var id : String setget , _get_id
var _id = null
func _get_id() -> String:
return "" if not _id is String else String(_id)
# The maximum score updates allowed per player for the current tournament.
var max_num_score : int setget , _get_max_num_score
var _max_num_score = null
func _get_max_num_score() -> int:
return 0 if not _max_num_score is int else int(_max_num_score)
# The maximum number of players for the tournament.
var max_size : int setget , _get_max_size
var _max_size = null
func _get_max_size() -> int:
return 0 if not _max_size is int else int(_max_size)
# Additional information stored as a JSON object.
var metadata : String setget , _get_metadata
var _metadata = null
func _get_metadata() -> String:
return "" if not _metadata is String else String(_metadata)
# The UNIX time when the tournament is next playable. A computed value.
var next_reset : int setget , _get_next_reset
var _next_reset = null
func _get_next_reset() -> int:
return 0 if not _next_reset is int else int(_next_reset)
# The current number of players in the tournament.
var size : int setget , _get_size
var _size = null
func _get_size() -> int:
return 0 if not _size is int else int(_size)
# ASC or DESC sort mode of scores in the tournament.
var sort_order : int setget , _get_sort_order
var _sort_order = null
func _get_sort_order() -> int:
return 0 if not _sort_order is int else int(_sort_order)
# The UNIX time when the tournament start being active. A computed value.
var start_active : int setget , _get_start_active
var _start_active = null
func _get_start_active() -> int:
return 0 if not _start_active is int else int(_start_active)
# The UNIX time when the tournament will start.
var start_time : String setget , _get_start_time
var _start_time = null
func _get_start_time() -> String:
return "" if not _start_time is String else String(_start_time)
# The title for the tournament.
var title : String setget , _get_title
var _title = null
func _get_title() -> String:
return "" if not _title is String else String(_title)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiTournament:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiTournament", p_dict), ApiTournament) as ApiTournament
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "can_enter: %s, " % _can_enter
output += "category: %s, " % _category
output += "create_time: %s, " % _create_time
output += "description: %s, " % _description
output += "duration: %s, " % _duration
output += "end_active: %s, " % _end_active
output += "end_time: %s, " % _end_time
output += "id: %s, " % _id
output += "max_num_score: %s, " % _max_num_score
output += "max_size: %s, " % _max_size
output += "metadata: %s, " % _metadata
output += "next_reset: %s, " % _next_reset
output += "size: %s, " % _size
output += "sort_order: %s, " % _sort_order
output += "start_active: %s, " % _start_active
output += "start_time: %s, " % _start_time
output += "title: %s, " % _title
return output
# A list of tournaments.
class ApiTournamentList extends NakamaAsyncResult:
const _SCHEMA = {
"cursor": {"name": "_cursor", "type": TYPE_STRING, "required": false},
"tournaments": {"name": "_tournaments", "type": TYPE_ARRAY, "required": false, "content": "ApiTournament"},
}
# A pagination cursor (optional).
var cursor : String setget , _get_cursor
var _cursor = null
func _get_cursor() -> String:
return "" if not _cursor is String else String(_cursor)
# The list of tournaments returned.
var tournaments : Array setget , _get_tournaments
var _tournaments = null
func _get_tournaments() -> Array:
return Array() if not _tournaments is Array else Array(_tournaments)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiTournamentList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiTournamentList", p_dict), ApiTournamentList) as ApiTournamentList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "cursor: %s, " % _cursor
output += "tournaments: %s, " % [_tournaments]
return output
# A set of tournament records which may be part of a tournament records page or a batch of individual records.
class ApiTournamentRecordList extends NakamaAsyncResult:
const _SCHEMA = {
"next_cursor": {"name": "_next_cursor", "type": TYPE_STRING, "required": false},
"owner_records": {"name": "_owner_records", "type": TYPE_ARRAY, "required": false, "content": "ApiLeaderboardRecord"},
"prev_cursor": {"name": "_prev_cursor", "type": TYPE_STRING, "required": false},
"records": {"name": "_records", "type": TYPE_ARRAY, "required": false, "content": "ApiLeaderboardRecord"},
}
# The cursor to send when retireving the next page (optional).
var next_cursor : String setget , _get_next_cursor
var _next_cursor = null
func _get_next_cursor() -> String:
return "" if not _next_cursor is String else String(_next_cursor)
# A batched set of tournament records belonging to specified owners.
var owner_records : Array setget , _get_owner_records
var _owner_records = null
func _get_owner_records() -> Array:
return Array() if not _owner_records is Array else Array(_owner_records)
# The cursor to send when retrieving the previous page (optional).
var prev_cursor : String setget , _get_prev_cursor
var _prev_cursor = null
func _get_prev_cursor() -> String:
return "" if not _prev_cursor is String else String(_prev_cursor)
# A list of tournament records.
var records : Array setget , _get_records
var _records = null
func _get_records() -> Array:
return Array() if not _records is Array else Array(_records)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiTournamentRecordList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiTournamentRecordList", p_dict), ApiTournamentRecordList) as ApiTournamentRecordList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "next_cursor: %s, " % _next_cursor
output += "owner_records: %s, " % [_owner_records]
output += "prev_cursor: %s, " % _prev_cursor
output += "records: %s, " % [_records]
return output
# Update a user's account details.
class ApiUpdateAccountRequest extends NakamaAsyncResult:
const _SCHEMA = {
"avatar_url": {"name": "_avatar_url", "type": TYPE_STRING, "required": false},
"display_name": {"name": "_display_name", "type": TYPE_STRING, "required": false},
"lang_tag": {"name": "_lang_tag", "type": TYPE_STRING, "required": false},
"location": {"name": "_location", "type": TYPE_STRING, "required": false},
"timezone": {"name": "_timezone", "type": TYPE_STRING, "required": false},
"username": {"name": "_username", "type": TYPE_STRING, "required": false},
}
# A URL for an avatar image.
var avatar_url : String setget , _get_avatar_url
var _avatar_url = null
func _get_avatar_url() -> String:
return "" if not _avatar_url is String else String(_avatar_url)
# The display name of the user.
var display_name : String setget , _get_display_name
var _display_name = null
func _get_display_name() -> String:
return "" if not _display_name is String else String(_display_name)
# The language expected to be a tag which follows the BCP-47 spec.
var lang_tag : String setget , _get_lang_tag
var _lang_tag = null
func _get_lang_tag() -> String:
return "" if not _lang_tag is String else String(_lang_tag)
# The location set by the user.
var location : String setget , _get_location
var _location = null
func _get_location() -> String:
return "" if not _location is String else String(_location)
# The timezone set by the user.
var timezone : String setget , _get_timezone
var _timezone = null
func _get_timezone() -> String:
return "" if not _timezone is String else String(_timezone)
# The username of the user's account.
var username : String setget , _get_username
var _username = null
func _get_username() -> String:
return "" if not _username is String else String(_username)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiUpdateAccountRequest:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiUpdateAccountRequest", p_dict), ApiUpdateAccountRequest) as ApiUpdateAccountRequest
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "avatar_url: %s, " % _avatar_url
output += "display_name: %s, " % _display_name
output += "lang_tag: %s, " % _lang_tag
output += "location: %s, " % _location
output += "timezone: %s, " % _timezone
output += "username: %s, " % _username
return output
# Update fields in a given group.
class ApiUpdateGroupRequest extends NakamaAsyncResult:
const _SCHEMA = {
"avatar_url": {"name": "_avatar_url", "type": TYPE_STRING, "required": false},
"description": {"name": "_description", "type": TYPE_STRING, "required": false},
"group_id": {"name": "_group_id", "type": TYPE_STRING, "required": false},
"lang_tag": {"name": "_lang_tag", "type": TYPE_STRING, "required": false},
"name": {"name": "_name", "type": TYPE_STRING, "required": false},
"open": {"name": "_open", "type": TYPE_BOOL, "required": false},
}
# Avatar URL.
var avatar_url : String setget , _get_avatar_url
var _avatar_url = null
func _get_avatar_url() -> String:
return "" if not _avatar_url is String else String(_avatar_url)
# Description string.
var description : String setget , _get_description
var _description = null
func _get_description() -> String:
return "" if not _description is String else String(_description)
# The ID of the group to update.
var group_id : String setget , _get_group_id
var _group_id = null
func _get_group_id() -> String:
return "" if not _group_id is String else String(_group_id)
# Lang tag.
var lang_tag : String setget , _get_lang_tag
var _lang_tag = null
func _get_lang_tag() -> String:
return "" if not _lang_tag is String else String(_lang_tag)
# Name.
var name : String setget , _get_name
var _name = null
func _get_name() -> String:
return "" if not _name is String else String(_name)
# Open is true if anyone should be allowed to join, or false if joins must be approved by a group admin.
var open : bool setget , _get_open
var _open = null
func _get_open() -> bool:
return false if not _open is bool else bool(_open)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiUpdateGroupRequest:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiUpdateGroupRequest", p_dict), ApiUpdateGroupRequest) as ApiUpdateGroupRequest
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "avatar_url: %s, " % _avatar_url
output += "description: %s, " % _description
output += "group_id: %s, " % _group_id
output += "lang_tag: %s, " % _lang_tag
output += "name: %s, " % _name
output += "open: %s, " % _open
return output
# A user in the server.
class ApiUser extends NakamaAsyncResult:
const _SCHEMA = {
"avatar_url": {"name": "_avatar_url", "type": TYPE_STRING, "required": false},
"create_time": {"name": "_create_time", "type": TYPE_STRING, "required": false},
"display_name": {"name": "_display_name", "type": TYPE_STRING, "required": false},
"edge_count": {"name": "_edge_count", "type": TYPE_INT, "required": false},
"facebook_id": {"name": "_facebook_id", "type": TYPE_STRING, "required": false},
"facebook_instant_game_id": {"name": "_facebook_instant_game_id", "type": TYPE_STRING, "required": false},
"gamecenter_id": {"name": "_gamecenter_id", "type": TYPE_STRING, "required": false},
"google_id": {"name": "_google_id", "type": TYPE_STRING, "required": false},
"id": {"name": "_id", "type": TYPE_STRING, "required": false},
"lang_tag": {"name": "_lang_tag", "type": TYPE_STRING, "required": false},
"location": {"name": "_location", "type": TYPE_STRING, "required": false},
"metadata": {"name": "_metadata", "type": TYPE_STRING, "required": false},
"online": {"name": "_online", "type": TYPE_BOOL, "required": false},
"steam_id": {"name": "_steam_id", "type": TYPE_STRING, "required": false},
"timezone": {"name": "_timezone", "type": TYPE_STRING, "required": false},
"update_time": {"name": "_update_time", "type": TYPE_STRING, "required": false},
"username": {"name": "_username", "type": TYPE_STRING, "required": false},
}
# A URL for an avatar image.
var avatar_url : String setget , _get_avatar_url
var _avatar_url = null
func _get_avatar_url() -> String:
return "" if not _avatar_url is String else String(_avatar_url)
# The UNIX time when the user was created.
var create_time : String setget , _get_create_time
var _create_time = null
func _get_create_time() -> String:
return "" if not _create_time is String else String(_create_time)
# The display name of the user.
var display_name : String setget , _get_display_name
var _display_name = null
func _get_display_name() -> String:
return "" if not _display_name is String else String(_display_name)
# Number of related edges to this user.
var edge_count : int setget , _get_edge_count
var _edge_count = null
func _get_edge_count() -> int:
return 0 if not _edge_count is int else int(_edge_count)
# The Facebook id in the user's account.
var facebook_id : String setget , _get_facebook_id
var _facebook_id = null
func _get_facebook_id() -> String:
return "" if not _facebook_id is String else String(_facebook_id)
# The Facebook Instant Game id in the user's account.
var facebook_instant_game_id : String setget , _get_facebook_instant_game_id
var _facebook_instant_game_id = null
func _get_facebook_instant_game_id() -> String:
return "" if not _facebook_instant_game_id is String else String(_facebook_instant_game_id)
# The Apple Game Center in of the user's account.
var gamecenter_id : String setget , _get_gamecenter_id
var _gamecenter_id = null
func _get_gamecenter_id() -> String:
return "" if not _gamecenter_id is String else String(_gamecenter_id)
# The Google id in the user's account.
var google_id : String setget , _get_google_id
var _google_id = null
func _get_google_id() -> String:
return "" if not _google_id is String else String(_google_id)
# The id of the user's account.
var id : String setget , _get_id
var _id = null
func _get_id() -> String:
return "" if not _id is String else String(_id)
# The language expected to be a tag which follows the BCP-47 spec.
var lang_tag : String setget , _get_lang_tag
var _lang_tag = null
func _get_lang_tag() -> String:
return "" if not _lang_tag is String else String(_lang_tag)
# The location set by the user.
var location : String setget , _get_location
var _location = null
func _get_location() -> String:
return "" if not _location is String else String(_location)
# Additional information stored as a JSON object.
var metadata : String setget , _get_metadata
var _metadata = null
func _get_metadata() -> String:
return "" if not _metadata is String else String(_metadata)
# Indicates whether the user is currently online.
var online : bool setget , _get_online
var _online = null
func _get_online() -> bool:
return false if not _online is bool else bool(_online)
# The Steam id in the user's account.
var steam_id : String setget , _get_steam_id
var _steam_id = null
func _get_steam_id() -> String:
return "" if not _steam_id is String else String(_steam_id)
# The timezone set by the user.
var timezone : String setget , _get_timezone
var _timezone = null
func _get_timezone() -> String:
return "" if not _timezone is String else String(_timezone)
# The UNIX time when the user was last updated.
var update_time : String setget , _get_update_time
var _update_time = null
func _get_update_time() -> String:
return "" if not _update_time is String else String(_update_time)
# The username of the user's account.
var username : String setget , _get_username
var _username = null
func _get_username() -> String:
return "" if not _username is String else String(_username)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiUser:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiUser", p_dict), ApiUser) as ApiUser
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "avatar_url: %s, " % _avatar_url
output += "create_time: %s, " % _create_time
output += "display_name: %s, " % _display_name
output += "edge_count: %s, " % _edge_count
output += "facebook_id: %s, " % _facebook_id
output += "facebook_instant_game_id: %s, " % _facebook_instant_game_id
output += "gamecenter_id: %s, " % _gamecenter_id
output += "google_id: %s, " % _google_id
output += "id: %s, " % _id
output += "lang_tag: %s, " % _lang_tag
output += "location: %s, " % _location
output += "metadata: %s, " % _metadata
output += "online: %s, " % _online
output += "steam_id: %s, " % _steam_id
output += "timezone: %s, " % _timezone
output += "update_time: %s, " % _update_time
output += "username: %s, " % _username
return output
# A list of groups belonging to a user, along with the user's role in each group.
class ApiUserGroupList extends NakamaAsyncResult:
const _SCHEMA = {
"cursor": {"name": "_cursor", "type": TYPE_STRING, "required": false},
"user_groups": {"name": "_user_groups", "type": TYPE_ARRAY, "required": false, "content": "UserGroupListUserGroup"},
}
# Cursor for the next page of results, if any.
var cursor : String setget , _get_cursor
var _cursor = null
func _get_cursor() -> String:
return "" if not _cursor is String else String(_cursor)
# Group-role pairs for a user.
var user_groups : Array setget , _get_user_groups
var _user_groups = null
func _get_user_groups() -> Array:
return Array() if not _user_groups is Array else Array(_user_groups)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiUserGroupList:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiUserGroupList", p_dict), ApiUserGroupList) as ApiUserGroupList
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "cursor: %s, " % _cursor
output += "user_groups: %s, " % [_user_groups]
return output
# A collection of zero or more users.
class ApiUsers extends NakamaAsyncResult:
const _SCHEMA = {
"users": {"name": "_users", "type": TYPE_ARRAY, "required": false, "content": "ApiUser"},
}
# The User objects.
var users : Array setget , _get_users
var _users = null
func _get_users() -> Array:
return Array() if not _users is Array else Array(_users)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiUsers:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiUsers", p_dict), ApiUsers) as ApiUsers
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "users: %s, " % [_users]
return output
# The object to store.
class ApiWriteStorageObject extends NakamaAsyncResult:
const _SCHEMA = {
"collection": {"name": "_collection", "type": TYPE_STRING, "required": false},
"key": {"name": "_key", "type": TYPE_STRING, "required": false},
"permission_read": {"name": "_permission_read", "type": TYPE_INT, "required": false},
"permission_write": {"name": "_permission_write", "type": TYPE_INT, "required": false},
"value": {"name": "_value", "type": TYPE_STRING, "required": false},
"version": {"name": "_version", "type": TYPE_STRING, "required": false},
}
# The collection to store the object.
var collection : String setget , _get_collection
var _collection = null
func _get_collection() -> String:
return "" if not _collection is String else String(_collection)
# The key for the object within the collection.
var key : String setget , _get_key
var _key = null
func _get_key() -> String:
return "" if not _key is String else String(_key)
# The read access permissions for the object.
var permission_read : int setget , _get_permission_read
var _permission_read = null
func _get_permission_read() -> int:
return 0 if not _permission_read is int else int(_permission_read)
# The write access permissions for the object.
var permission_write : int setget , _get_permission_write
var _permission_write = null
func _get_permission_write() -> int:
return 0 if not _permission_write is int else int(_permission_write)
# The value of the object.
var value : String setget , _get_value
var _value = null
func _get_value() -> String:
return "" if not _value is String else String(_value)
# The version hash of the object to check. Possible values are: ["", "*", "#hash#"].
var version : String setget , _get_version
var _version = null
func _get_version() -> String:
return "" if not _version is String else String(_version)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiWriteStorageObject:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiWriteStorageObject", p_dict), ApiWriteStorageObject) as ApiWriteStorageObject
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "collection: %s, " % _collection
output += "key: %s, " % _key
output += "permission_read: %s, " % _permission_read
output += "permission_write: %s, " % _permission_write
output += "value: %s, " % _value
output += "version: %s, " % _version
return output
# Write objects to the storage engine.
class ApiWriteStorageObjectsRequest extends NakamaAsyncResult:
const _SCHEMA = {
"objects": {"name": "_objects", "type": TYPE_ARRAY, "required": false, "content": "ApiWriteStorageObject"},
}
# The objects to store on the server.
var objects : Array setget , _get_objects
var _objects = null
func _get_objects() -> Array:
return Array() if not _objects is Array else Array(_objects)
func _init(p_exception = null).(p_exception):
pass
static func create(p_ns : GDScript, p_dict : Dictionary) -> ApiWriteStorageObjectsRequest:
return _safe_ret(NakamaSerializer.deserialize(p_ns, "ApiWriteStorageObjectsRequest", p_dict), ApiWriteStorageObjectsRequest) as ApiWriteStorageObjectsRequest
func serialize() -> Dictionary:
return NakamaSerializer.serialize(self)
func _to_string() -> String:
if is_exception():
return get_exception()._to_string()
var output : String = ""
output += "objects: %s, " % [_objects]
return output
# The low level client for the Nakama API.
class ApiClient extends Reference:
var _base_uri : String
var _timeout : int
var _http_adapter
var _namespace
func _init(p_base_uri : String, p_http_adapter, p_namespace : GDScript, p_timeout : int = 10):
_base_uri = p_base_uri
_timeout = p_timeout
_http_adapter = p_http_adapter
_namespace = p_namespace
# A healthcheck which load balancers can use to check the service.
func healthcheck_async(
p_bearer_token : String
) -> NakamaAsyncResult:
var urlpath : String = "/healthcheck"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Fetch the current user's account.
func get_account_async(
p_bearer_token : String
) -> ApiAccount:
var urlpath : String = "/v2/account"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiAccount.new(result)
var out : ApiAccount = NakamaSerializer.deserialize(_namespace, "ApiAccount", result)
return out
# Update fields in the current user's account.
func update_account_async(
p_bearer_token : String
, p_body : ApiUpdateAccountRequest
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "PUT"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Authenticate a user with a custom id against the server.
func authenticate_custom_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountCustom
, p_create = null # : boolean
, p_username = null # : string
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/custom"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Authenticate a user with a device id against the server.
func authenticate_device_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountDevice
, p_create = null # : boolean
, p_username = null # : string
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/device"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Authenticate a user with an email+password against the server.
func authenticate_email_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountEmail
, p_create = null # : boolean
, p_username = null # : string
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/email"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Authenticate a user with a Facebook OAuth token against the server.
func authenticate_facebook_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountFacebook
, p_create = null # : boolean
, p_username = null # : string
, p_sync = null # : boolean
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/facebook"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
if p_sync != null:
query_params += "sync=%s&" % str(bool(p_sync)).to_lower()
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Authenticate a user with a Facebook Instant Game token against the server.
func authenticate_facebook_instant_game_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountFacebookInstantGame
, p_create = null # : boolean
, p_username = null # : string
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/facebookinstantgame"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Authenticate a user with Apple's GameCenter against the server.
func authenticate_game_center_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountGameCenter
, p_create = null # : boolean
, p_username = null # : string
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/gamecenter"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Authenticate a user with Google against the server.
func authenticate_google_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountGoogle
, p_create = null # : boolean
, p_username = null # : string
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/google"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Authenticate a user with Steam against the server.
func authenticate_steam_async(
p_basic_auth_username : String
, p_basic_auth_password : String
, p_body : ApiAccountSteam
, p_create = null # : boolean
, p_username = null # : string
) -> ApiSession:
var urlpath : String = "/v2/account/authenticate/steam"
var query_params = ""
if p_create != null:
query_params += "create=%s&" % str(bool(p_create)).to_lower()
if p_username != null:
query_params += "username=%s&" % NakamaSerializer.escape_http(p_username)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var credentials = Marshalls.utf8_to_base64(p_basic_auth_username + ":" + p_basic_auth_password)
var header = "Basic %s" % credentials
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiSession.new(result)
var out : ApiSession = NakamaSerializer.deserialize(_namespace, "ApiSession", result)
return out
# Add a custom ID to the social profiles on the current user's account.
func link_custom_async(
p_bearer_token : String
, p_body : ApiAccountCustom
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/custom"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add a device ID to the social profiles on the current user's account.
func link_device_async(
p_bearer_token : String
, p_body : ApiAccountDevice
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/device"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add an email+password to the social profiles on the current user's account.
func link_email_async(
p_bearer_token : String
, p_body : ApiAccountEmail
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/email"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add Facebook to the social profiles on the current user's account.
func link_facebook_async(
p_bearer_token : String
, p_body : ApiAccountFacebook
, p_sync = null # : boolean
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/facebook"
var query_params = ""
if p_sync != null:
query_params += "sync=%s&" % str(bool(p_sync)).to_lower()
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add Facebook Instant Game to the social profiles on the current user's account.
func link_facebook_instant_game_async(
p_bearer_token : String,
p_body : ApiAccountFacebookInstantGame
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/facebookinstantgame"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add Apple's GameCenter to the social profiles on the current user's account.
func link_game_center_async(
p_bearer_token : String
, p_body : ApiAccountGameCenter
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/gamecenter"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add Google to the social profiles on the current user's account.
func link_google_async(
p_bearer_token : String
, p_body : ApiAccountGoogle
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/google"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add Steam to the social profiles on the current user's account.
func link_steam_async(
p_bearer_token : String
, p_body : ApiAccountSteam
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/link/steam"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove the custom ID from the social profiles on the current user's account.
func unlink_custom_async(
p_bearer_token : String
, p_body : ApiAccountCustom
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/custom"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove the device ID from the social profiles on the current user's account.
func unlink_device_async(
p_bearer_token : String
, p_body : ApiAccountDevice
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/device"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove the email+password from the social profiles on the current user's account.
func unlink_email_async(
p_bearer_token : String
, p_body : ApiAccountEmail
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/email"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove Facebook from the social profiles on the current user's account.
func unlink_facebook_async(
p_bearer_token : String
, p_body : ApiAccountFacebook
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/facebook"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove Facebook Instant Game profile from the social profiles on the current user's account.
func unlink_facebook_instant_game_async(
p_bearer_token : String
, p_body : ApiAccountFacebookInstantGame
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/facebookinstantgame"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove Apple's GameCenter from the social profiles on the current user's account.
func unlink_game_center_async(
p_bearer_token : String
, p_body : ApiAccountGameCenter
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/gamecenter"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove Google from the social profiles on the current user's account.
func unlink_google_async(
p_bearer_token : String
, p_body : ApiAccountGoogle
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/google"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Remove Steam from the social profiles on the current user's account.
func unlink_steam_async(
p_bearer_token : String
, p_body : ApiAccountSteam
) -> NakamaAsyncResult:
var urlpath : String = "/v2/account/unlink/steam"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# List a channel's message history.
func list_channel_messages_async(
p_bearer_token : String
, p_channel_id : String
, p_limit = null # : integer
, p_forward = null # : boolean
, p_cursor = null # : string
) -> ApiChannelMessageList:
var urlpath : String = "/v2/channel/{channel_id}"
urlpath = urlpath.replace("{channel_id}", NakamaSerializer.escape_http(p_channel_id))
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_forward != null:
query_params += "forward=%s&" % str(bool(p_forward)).to_lower()
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiChannelMessageList.new(result)
var out : ApiChannelMessageList = NakamaSerializer.deserialize(_namespace, "ApiChannelMessageList", result)
return out
# Submit an event for processing in the server's registered runtime custom events handler.
func event_async(
p_bearer_token : String
, p_body : ApiEvent
) -> NakamaAsyncResult:
var urlpath : String = "/v2/event"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Delete one or more users by ID or username.
func delete_friends_async(
p_bearer_token : String
, p_ids = null # : array
, p_usernames = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/friend"
var query_params = ""
if p_ids != null:
for elem in p_ids:
query_params += "ids=%s&" % elem
if p_usernames != null:
for elem in p_usernames:
query_params += "usernames=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "DELETE"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# List all friends for the current user.
func list_friends_async(
p_bearer_token : String
, p_limit = null # : integer
, p_state = null # : integer
, p_cursor = null # : string
) -> ApiFriendList:
var urlpath : String = "/v2/friend"
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_state != null:
query_params += "state=%d&" % p_state
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiFriendList.new(result)
var out : ApiFriendList = NakamaSerializer.deserialize(_namespace, "ApiFriendList", result)
return out
# Add friends by ID or username to a user's account.
func add_friends_async(
p_bearer_token : String
, p_ids = null # : array
, p_usernames = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/friend"
var query_params = ""
if p_ids != null:
for elem in p_ids:
query_params += "ids=%s&" % elem
if p_usernames != null:
for elem in p_usernames:
query_params += "usernames=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Block one or more users by ID or username.
func block_friends_async(
p_bearer_token : String
, p_ids = null # : array
, p_usernames = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/friend/block"
var query_params = ""
if p_ids != null:
for elem in p_ids:
query_params += "ids=%s&" % elem
if p_usernames != null:
for elem in p_usernames:
query_params += "usernames=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Import Facebook friends and add them to a user's account.
func import_facebook_friends_async(
p_bearer_token : String
, p_body : ApiAccountFacebook
, p_reset = null # : boolean
) -> NakamaAsyncResult:
var urlpath : String = "/v2/friend/facebook"
var query_params = ""
if p_reset != null:
query_params += "reset=%s&" % str(bool(p_reset)).to_lower()
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# List groups based on given filters.
func list_groups_async(
p_bearer_token : String
, p_name = null # : string
, p_cursor = null # : string
, p_limit = null # : integer
) -> ApiGroupList:
var urlpath : String = "/v2/group"
var query_params = ""
if p_name != null:
query_params += "name=%s&" % NakamaSerializer.escape_http(p_name)
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
if p_limit != null:
query_params += "limit=%d&" % p_limit
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiGroupList.new(result)
var out : ApiGroupList = NakamaSerializer.deserialize(_namespace, "ApiGroupList", result)
return out
# Create a new group with the current user as the owner.
func create_group_async(
p_bearer_token : String
, p_body : ApiCreateGroupRequest
) -> ApiGroup:
var urlpath : String = "/v2/group"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiGroup.new(result)
var out : ApiGroup = NakamaSerializer.deserialize(_namespace, "ApiGroup", result)
return out
# Delete a group by ID.
func delete_group_async(
p_bearer_token : String
, p_group_id : String
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "DELETE"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Update fields in a given group.
func update_group_async(
p_bearer_token : String
, p_group_id : String
, p_body : ApiUpdateGroupRequest
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "PUT"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Add users to a group.
func add_group_users_async(
p_bearer_token : String
, p_group_id : String
, p_user_ids = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}/add"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
if p_user_ids != null:
for elem in p_user_ids:
query_params += "user_ids=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Ban a set of users from a group.
func ban_group_users_async(
p_bearer_token : String
, p_group_id : String
, p_user_ids = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}/ban"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
if p_user_ids != null:
for elem in p_user_ids:
query_params += "user_ids=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Immediately join an open group, or request to join a closed one.
func join_group_async(
p_bearer_token : String
, p_group_id : String
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}/join"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Kick a set of users from a group.
func kick_group_users_async(
p_bearer_token : String
, p_group_id : String
, p_user_ids = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}/kick"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
if p_user_ids != null:
for elem in p_user_ids:
query_params += "user_ids=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Leave a group the user is a member of.
func leave_group_async(
p_bearer_token : String
, p_group_id : String
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}/leave"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Promote a set of users in a group to the next role up.
func promote_group_users_async(
p_bearer_token : String
, p_group_id : String
, p_user_ids = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/group/{group_id}/promote"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
if p_user_ids != null:
for elem in p_user_ids:
query_params += "user_ids=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# List all users that are part of a group.
func list_group_users_async(
p_bearer_token : String
, p_group_id : String
, p_limit = null # : integer
, p_state = null # : integer
, p_cursor = null # : string
) -> ApiGroupUserList:
var urlpath : String = "/v2/group/{group_id}/user"
urlpath = urlpath.replace("{group_id}", NakamaSerializer.escape_http(p_group_id))
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_state != null:
query_params += "state=%d&" % p_state
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiGroupUserList.new(result)
var out : ApiGroupUserList = NakamaSerializer.deserialize(_namespace, "ApiGroupUserList", result)
return out
# Delete a leaderboard record.
func delete_leaderboard_record_async(
p_bearer_token : String
, p_leaderboard_id : String
) -> NakamaAsyncResult:
var urlpath : String = "/v2/leaderboard/{leaderboard_id}"
urlpath = urlpath.replace("{leaderboard_id}", NakamaSerializer.escape_http(p_leaderboard_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "DELETE"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# List leaderboard records.
func list_leaderboard_records_async(
p_bearer_token : String
, p_leaderboard_id : String
, p_owner_ids = null # : array
, p_limit = null # : integer
, p_cursor = null # : string
, p_expiry = null # : string
) -> ApiLeaderboardRecordList:
var urlpath : String = "/v2/leaderboard/{leaderboard_id}"
urlpath = urlpath.replace("{leaderboard_id}", NakamaSerializer.escape_http(p_leaderboard_id))
var query_params = ""
if p_owner_ids != null:
for elem in p_owner_ids:
query_params += "owner_ids=%s&" % elem
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
if p_expiry != null:
query_params += "expiry=%s&" % NakamaSerializer.escape_http(p_expiry)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiLeaderboardRecordList.new(result)
var out : ApiLeaderboardRecordList = NakamaSerializer.deserialize(_namespace, "ApiLeaderboardRecordList", result)
return out
# Write a record to a leaderboard.
func write_leaderboard_record_async(
p_bearer_token : String
, p_leaderboard_id : String
, p_body : WriteLeaderboardRecordRequestLeaderboardRecordWrite
) -> ApiLeaderboardRecord:
var urlpath : String = "/v2/leaderboard/{leaderboard_id}"
urlpath = urlpath.replace("{leaderboard_id}", NakamaSerializer.escape_http(p_leaderboard_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiLeaderboardRecord.new(result)
var out : ApiLeaderboardRecord = NakamaSerializer.deserialize(_namespace, "ApiLeaderboardRecord", result)
return out
# List leaderboard records that belong to a user.
func list_leaderboard_records_around_owner_async(
p_bearer_token : String
, p_leaderboard_id : String
, p_owner_id : String
, p_limit = null # : integer
, p_expiry = null # : string
) -> ApiLeaderboardRecordList:
var urlpath : String = "/v2/leaderboard/{leaderboard_id}/owner/{owner_id}"
urlpath = urlpath.replace("{leaderboard_id}", NakamaSerializer.escape_http(p_leaderboard_id))
urlpath = urlpath.replace("{owner_id}", NakamaSerializer.escape_http(p_owner_id))
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_expiry != null:
query_params += "expiry=%s&" % NakamaSerializer.escape_http(p_expiry)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiLeaderboardRecordList.new(result)
var out : ApiLeaderboardRecordList = NakamaSerializer.deserialize(_namespace, "ApiLeaderboardRecordList", result)
return out
# Fetch list of running matches.
func list_matches_async(
p_bearer_token : String
, p_limit = null # : integer
, p_authoritative = null # : boolean
, p_label = null # : string
, p_min_size = null # : integer
, p_max_size = null # : integer
, p_query = null # : string
) -> ApiMatchList:
var urlpath : String = "/v2/match"
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_authoritative != null:
query_params += "authoritative=%s&" % str(bool(p_authoritative)).to_lower()
if p_label != null:
query_params += "label=%s&" % NakamaSerializer.escape_http(p_label)
if p_min_size != null:
query_params += "min_size=%d&" % p_min_size
if p_max_size != null:
query_params += "max_size=%d&" % p_max_size
if p_query != null:
query_params += "query=%s&" % NakamaSerializer.escape_http(p_query)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiMatchList.new(result)
var out : ApiMatchList = NakamaSerializer.deserialize(_namespace, "ApiMatchList", result)
return out
# Delete one or more notifications for the current user.
func delete_notifications_async(
p_bearer_token : String
, p_ids = null # : array
) -> NakamaAsyncResult:
var urlpath : String = "/v2/notification"
var query_params = ""
if p_ids != null:
for elem in p_ids:
query_params += "ids=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "DELETE"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# Fetch list of notifications.
func list_notifications_async(
p_bearer_token : String
, p_limit = null # : integer
, p_cacheable_cursor = null # : string
) -> ApiNotificationList:
var urlpath : String = "/v2/notification"
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_cacheable_cursor != null:
query_params += "cacheable_cursor=%s&" % NakamaSerializer.escape_http(p_cacheable_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiNotificationList.new(result)
var out : ApiNotificationList = NakamaSerializer.deserialize(_namespace, "ApiNotificationList", result)
return out
# Execute a Lua function on the server.
func rpc_func2_async(
p_bearer_token : String
, p_id : String
, p_payload = null # : string
, p_http_key = null # : string
) -> ApiRpc:
var urlpath : String = "/v2/rpc/{id}"
urlpath = urlpath.replace("{id}", NakamaSerializer.escape_http(p_id))
var query_params = ""
if p_payload != null:
query_params += "payload=%s&" % NakamaSerializer.escape_http(p_payload)
if p_http_key != null:
query_params += "http_key=%s&" % NakamaSerializer.escape_http(p_http_key)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
if (p_bearer_token):
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiRpc.new(result)
var out : ApiRpc = NakamaSerializer.deserialize(_namespace, "ApiRpc", result)
return out
# Execute a Lua function on the server.
func rpc_func_async(
p_bearer_token : String
, p_id : String
, p_body : String
) -> ApiRpc:
var urlpath : String = "/v2/rpc/{id}"
urlpath = urlpath.replace("{id}", NakamaSerializer.escape_http(p_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
if (p_bearer_token):
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiRpc.new(result)
var out : ApiRpc = NakamaSerializer.deserialize(_namespace, "ApiRpc", result)
return out
# Get storage objects.
func read_storage_objects_async(
p_bearer_token : String
, p_body : ApiReadStorageObjectsRequest
) -> ApiStorageObjects:
var urlpath : String = "/v2/storage"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiStorageObjects.new(result)
var out : ApiStorageObjects = NakamaSerializer.deserialize(_namespace, "ApiStorageObjects", result)
return out
# Write objects into the storage engine.
func write_storage_objects_async(
p_bearer_token : String
, p_body : ApiWriteStorageObjectsRequest
) -> ApiStorageObjectAcks:
var urlpath : String = "/v2/storage"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "PUT"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiStorageObjectAcks.new(result)
var out : ApiStorageObjectAcks = NakamaSerializer.deserialize(_namespace, "ApiStorageObjectAcks", result)
return out
# Delete one or more objects by ID or username.
func delete_storage_objects_async(
p_bearer_token : String
, p_body : ApiDeleteStorageObjectsRequest
) -> NakamaAsyncResult:
var urlpath : String = "/v2/storage/delete"
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "PUT"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# List publicly readable storage objects in a given collection.
func list_storage_objects_async(
p_bearer_token : String
, p_collection : String
, p_user_id = null # : string
, p_limit = null # : integer
, p_cursor = null # : string
) -> ApiStorageObjectList:
var urlpath : String = "/v2/storage/{collection}"
urlpath = urlpath.replace("{collection}", NakamaSerializer.escape_http(p_collection))
var query_params = ""
if p_user_id != null:
query_params += "user_id=%s&" % NakamaSerializer.escape_http(p_user_id)
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiStorageObjectList.new(result)
var out : ApiStorageObjectList = NakamaSerializer.deserialize(_namespace, "ApiStorageObjectList", result)
return out
# List publicly readable storage objects in a given collection.
func list_storage_objects2_async(
p_bearer_token : String
, p_collection : String
, p_user_id : String
, p_limit = null # : integer
, p_cursor = null # : string
) -> ApiStorageObjectList:
var urlpath : String = "/v2/storage/{collection}/{user_id}"
urlpath = urlpath.replace("{collection}", NakamaSerializer.escape_http(p_collection))
urlpath = urlpath.replace("{user_id}", NakamaSerializer.escape_http(p_user_id))
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiStorageObjectList.new(result)
var out : ApiStorageObjectList = NakamaSerializer.deserialize(_namespace, "ApiStorageObjectList", result)
return out
# List current or upcoming tournaments.
func list_tournaments_async(
p_bearer_token : String
, p_category_start = null # : integer
, p_category_end = null # : integer
, p_start_time = null # : integer
, p_end_time = null # : integer
, p_limit = null # : integer
, p_cursor = null # : string
) -> ApiTournamentList:
var urlpath : String = "/v2/tournament"
var query_params = ""
if p_category_start != null:
query_params += "category_start=%d&" % p_category_start
if p_category_end != null:
query_params += "category_end=%d&" % p_category_end
if p_start_time != null:
query_params += "start_time=%d&" % p_start_time
if p_end_time != null:
query_params += "end_time=%d&" % p_end_time
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiTournamentList.new(result)
var out : ApiTournamentList = NakamaSerializer.deserialize(_namespace, "ApiTournamentList", result)
return out
# List tournament records.
func list_tournament_records_async(
p_bearer_token : String
, p_tournament_id : String
, p_owner_ids = null # : array
, p_limit = null # : integer
, p_cursor = null # : string
, p_expiry = null # : string
) -> ApiTournamentRecordList:
var urlpath : String = "/v2/tournament/{tournament_id}"
urlpath = urlpath.replace("{tournament_id}", NakamaSerializer.escape_http(p_tournament_id))
var query_params = ""
if p_owner_ids != null:
for elem in p_owner_ids:
query_params += "owner_ids=%s&" % elem
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
if p_expiry != null:
query_params += "expiry=%s&" % NakamaSerializer.escape_http(p_expiry)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiTournamentRecordList.new(result)
var out : ApiTournamentRecordList = NakamaSerializer.deserialize(_namespace, "ApiTournamentRecordList", result)
return out
# Write a record to a tournament.
func write_tournament_record_async(
p_bearer_token : String
, p_tournament_id : String
, p_body : WriteTournamentRecordRequestTournamentRecordWrite
) -> ApiLeaderboardRecord:
var urlpath : String = "/v2/tournament/{tournament_id}"
urlpath = urlpath.replace("{tournament_id}", NakamaSerializer.escape_http(p_tournament_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "PUT"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
content = JSON.print(p_body.serialize()).to_utf8()
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiLeaderboardRecord.new(result)
var out : ApiLeaderboardRecord = NakamaSerializer.deserialize(_namespace, "ApiLeaderboardRecord", result)
return out
# Attempt to join an open and running tournament.
func join_tournament_async(
p_bearer_token : String
, p_tournament_id : String
) -> NakamaAsyncResult:
var urlpath : String = "/v2/tournament/{tournament_id}/join"
urlpath = urlpath.replace("{tournament_id}", NakamaSerializer.escape_http(p_tournament_id))
var query_params = ""
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "POST"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return NakamaAsyncResult.new(result)
return NakamaAsyncResult.new()
# List tournament records for a given owner.
func list_tournament_records_around_owner_async(
p_bearer_token : String
, p_tournament_id : String
, p_owner_id : String
, p_limit = null # : integer
, p_expiry = null # : string
) -> ApiTournamentRecordList:
var urlpath : String = "/v2/tournament/{tournament_id}/owner/{owner_id}"
urlpath = urlpath.replace("{tournament_id}", NakamaSerializer.escape_http(p_tournament_id))
urlpath = urlpath.replace("{owner_id}", NakamaSerializer.escape_http(p_owner_id))
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_expiry != null:
query_params += "expiry=%s&" % NakamaSerializer.escape_http(p_expiry)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiTournamentRecordList.new(result)
var out : ApiTournamentRecordList = NakamaSerializer.deserialize(_namespace, "ApiTournamentRecordList", result)
return out
# Fetch zero or more users by ID and/or username.
func get_users_async(
p_bearer_token : String
, p_ids = null # : array
, p_usernames = null # : array
, p_facebook_ids = null # : array
) -> ApiUsers:
var urlpath : String = "/v2/user"
var query_params = ""
if p_ids != null:
for elem in p_ids:
query_params += "ids=%s&" % elem
if p_usernames != null:
for elem in p_usernames:
query_params += "usernames=%s&" % elem
if p_facebook_ids != null:
for elem in p_facebook_ids:
query_params += "facebook_ids=%s&" % elem
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiUsers.new(result)
var out : ApiUsers = NakamaSerializer.deserialize(_namespace, "ApiUsers", result)
return out
# List groups the current user belongs to.
func list_user_groups_async(
p_bearer_token : String
, p_user_id : String
, p_limit = null # : integer
, p_state = null # : integer
, p_cursor = null # : string
) -> ApiUserGroupList:
var urlpath : String = "/v2/user/{user_id}/group"
urlpath = urlpath.replace("{user_id}", NakamaSerializer.escape_http(p_user_id))
var query_params = ""
if p_limit != null:
query_params += "limit=%d&" % p_limit
if p_state != null:
query_params += "state=%d&" % p_state
if p_cursor != null:
query_params += "cursor=%s&" % NakamaSerializer.escape_http(p_cursor)
var uri = "%s%s%s" % [_base_uri, urlpath, "?" + query_params if query_params else ""]
var method = "GET"
var headers = {}
var header = "Bearer %s" % p_bearer_token
headers["Authorization"] = header
var content : PoolByteArray
var result = yield(_http_adapter.send_async(method, uri, headers, content, _timeout), "completed")
if result is NakamaException:
return ApiUserGroupList.new(result)
var out : ApiUserGroupList = NakamaSerializer.deserialize(_namespace, "ApiUserGroupList", result)
return out