GitHub repository
On this page

heroiclabs/nakama-defold/nakama.nakama

Nakama Defold Client SDK

  • GitHub: heroiclabs/nakama-defold — pinned to 2fe3aed
    1. Pick a release from heroiclabs/nakama-defold releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as nakama from "nakama.nakama"

Functions

authenticate_custom(client: Client, body: { id: string; vars?: unknown; }, create: boolean, username: string, callback?: (result: unknown) => void): Session

Parameters

  • client: Client
  • body: { id: string; vars?: unknown; }
    • id: string
    • vars?: unknown
  • create: boolean
  • username: string
  • callback?: (result: unknown) => void

Returns

  • Session

create_client(config: ClientConfig): Client

Parameters

  • config: ClientConfig

Returns

  • Client

create_api_account_custom(id: string, vars?: unknown): { id: string; vars: unknown; }

Parameters

  • id: string
  • vars?: unknown

Returns

  • { id: string; vars: unknown; }
    • id: string
    • vars: unknown

set_bearer_token(client: Client, token: SessionToken)

Parameters

  • client: Client
  • token: SessionToken

sync(fn: () => void)

Parameters

  • fn: () => void

create_match_create_message()

create_match_leave_message(match_id: string)

Parameters

  • match_id: string

create_channel_message_send_message(channel_id: string, content: string)

Parameters

  • channel_id: string
  • content: string

create_channel_message_update_message(channel_id: string, message_id: string, content: string)

Parameters

  • channel_id: string
  • message_id: string
  • content: string

create_channel_message_remove_message(channel_id: string, message_id: string)

Parameters

  • channel_id: string
  • message_id: string

create_channel_join_message(target: any, type: any, persistence: any, hidden: any)

Parameters

  • target: any
  • type: any
  • persistence: any
  • hidden: any

create_channel_leave_message(channel_id: string)

Parameters

  • channel_id: string

create_matchmaker_add_message(query: string, min_count: any, max_count: any, string_properties: string, numeric_properties: any)

Parameters

  • query: string
  • min_count: any
  • max_count: any
  • string_properties: string
  • numeric_properties: any

create_matchmaker_remove_message(ticket: any)

Parameters

  • ticket: any

create_match_data_message(match_id: string, op_code: number, data: string)

Parameters

  • match_id: string
  • op_code: number
  • data: string

create_status_follow_message(user_ids: string)

Parameters

  • user_ids: string

create_status_unfollow_message(user_ids: string)

Parameters

  • user_ids: string

create_status_update_message(status: string)

Parameters

  • status: string

create_group_user_list_group_user(state_int: any, user_api_user: any)

Parameters

  • state_int: any
  • user_api_user: any

create_user_group_list_user_group(group_api_group: any, state_int: any)

Parameters

  • group_api_group: any
  • state_int: any

create_write_leaderboard_record_request_leaderboard_record_write(metadata_str: any, operator_api_operator: any, score_str: any, subscore_str: any)

Parameters

  • metadata_str: any
  • operator_api_operator: any
  • score_str: any
  • subscore_str: any

create_write_tournament_record_request_tournament_record_write(metadata_str: any, operator_api_operator: any, score_str: any, subscore_str: any)

Parameters

  • metadata_str: any
  • operator_api_operator: any
  • score_str: any
  • subscore_str: any

create_api_account(custom_id_str: any, devices_arr: any, disable_time_str: any, email_str: any, user_api_user: any, verify_time_str: any, wallet_str: any)

Parameters

  • custom_id_str: any
  • devices_arr: any
  • disable_time_str: any
  • email_str: any
  • user_api_user: any
  • verify_time_str: any
  • wallet_str: any

create_api_account_apple(token_str: any, vars_obj: any)

Parameters

  • token_str: any
  • vars_obj: any

create_api_account_device(id_str: any, vars_obj: any)

Parameters

  • id_str: any
  • vars_obj: any

create_api_account_email(email_str: any, password_str: any, vars_obj: any)

Parameters

  • email_str: any
  • password_str: any
  • vars_obj: any

create_api_account_facebook(token_str: any, vars_obj: any)

Parameters

  • token_str: any
  • vars_obj: any

create_api_account_facebook_instant_game(signed_player_info_str: any, vars_obj: any)

Parameters

  • signed_player_info_str: any
  • vars_obj: any

create_api_account_game_center(bundle_id_str: any, player_id_str: any, public_key_url_str: any, salt_str: any, signature_str: any, timestamp_seconds_str: any, vars_obj: any)

Parameters

  • bundle_id_str: any
  • player_id_str: any
  • public_key_url_str: any
  • salt_str: any
  • signature_str: any
  • timestamp_seconds_str: any
  • vars_obj: any

create_api_account_google(token_str: any, vars_obj: any)

Parameters

  • token_str: any
  • vars_obj: any

create_api_account_steam(token_str: any, vars_obj: any)

Parameters

  • token_str: any
  • vars_obj: any

create_api_channel_message(channel_id_str: any, code_int: any, content_str: any, create_time_str: any, group_id_str: any, message_id_str: any, persistent_bool: any, room_name_str: any, sender_id_str: any, update_time_str: any, user_id_one_str: any, user_id_two_str: any, username_str: any)

Parameters

  • channel_id_str: any
  • code_int: any
  • content_str: any
  • create_time_str: any
  • group_id_str: any
  • message_id_str: any
  • persistent_bool: any
  • room_name_str: any
  • sender_id_str: any
  • update_time_str: any
  • user_id_one_str: any
  • user_id_two_str: any
  • username_str: any

create_api_channel_message_list(cacheable_cursor_str: any, messages_arr: any, next_cursor_str: any, prev_cursor_str: any)

Parameters

  • cacheable_cursor_str: any
  • messages_arr: any
  • next_cursor_str: any
  • prev_cursor_str: any

create_api_create_group_request(avatar_url_str: any, description_str: any, lang_tag_str: any, max_count_int: any, name_str: any, open_bool: any)

Parameters

  • avatar_url_str: any
  • description_str: any
  • lang_tag_str: any
  • max_count_int: any
  • name_str: any
  • open_bool: any

create_api_delete_storage_object_id(collection_str: any, key_str: any, version_str: any)

Parameters

  • collection_str: any
  • key_str: any
  • version_str: any

create_api_delete_storage_objects_request(object_ids_arr: any)

Parameters

  • object_ids_arr: any

create_api_event(external_bool: any, name_str: any, properties_obj: any, timestamp_str: any)

Parameters

  • external_bool: any
  • name_str: any
  • properties_obj: any
  • timestamp_str: any

create_api_friend(state_int: any, update_time_str: any, user_api_user: any)

Parameters

  • state_int: any
  • update_time_str: any
  • user_api_user: any

create_api_friend_list(cursor_str: any, friends_arr: any)

Parameters

  • cursor_str: any
  • friends_arr: any

create_api_group(avatar_url_str: any, create_time_str: any, creator_id_str: any, description_str: any, edge_count_int: any, id_str: any, lang_tag_str: any, max_count_int: any, metadata_str: any, name_str: any, open_bool: any, update_time_str: any)

Parameters

  • avatar_url_str: any
  • create_time_str: any
  • creator_id_str: any
  • description_str: any
  • edge_count_int: any
  • id_str: any
  • lang_tag_str: any
  • max_count_int: any
  • metadata_str: any
  • name_str: any
  • open_bool: any
  • update_time_str: any

create_api_group_list(cursor_str: any, groups_arr: any)

Parameters

  • cursor_str: any
  • groups_arr: any

create_api_group_user_list(cursor_str: any, group_users_arr: any)

Parameters

  • cursor_str: any
  • group_users_arr: any

create_api_leaderboard_record(create_time_str: any, expiry_time_str: any, leaderboard_id_str: any, max_num_score_int: any, metadata_str: any, num_score_int: any, owner_id_str: any, rank_str: any, score_str: any, subscore_str: any, update_time_str: any, username_str: any)

Parameters

  • create_time_str: any
  • expiry_time_str: any
  • leaderboard_id_str: any
  • max_num_score_int: any
  • metadata_str: any
  • num_score_int: any
  • owner_id_str: any
  • rank_str: any
  • score_str: any
  • subscore_str: any
  • update_time_str: any
  • username_str: any

create_api_leaderboard_record_list(next_cursor_str: any, owner_records_arr: any, prev_cursor_str: any, records_arr: any)

Parameters

  • next_cursor_str: any
  • owner_records_arr: any
  • prev_cursor_str: any
  • records_arr: any

Parameters

  • account_api_account_steam: any
  • sync_bool: any

create_api_match(authoritative_bool: any, handler_name_str: any, label_str: any, match_id_str: any, size_int: any, tick_rate_int: any)

Parameters

  • authoritative_bool: any
  • handler_name_str: any
  • label_str: any
  • match_id_str: any
  • size_int: any
  • tick_rate_int: any

create_api_match_list(matches_arr: any)

Parameters

  • matches_arr: any

create_api_notification(code_int: any, content_str: any, create_time_str: any, id_str: any, persistent_bool: any, sender_id_str: any, subject_str: any)

Parameters

  • code_int: any
  • content_str: any
  • create_time_str: any
  • id_str: any
  • persistent_bool: any
  • sender_id_str: any
  • subject_str: any

create_api_notification_list(cacheable_cursor_str: any, notifications_arr: any)

Parameters

  • cacheable_cursor_str: any
  • notifications_arr: any

create_api_read_storage_object_id(collection_str: any, key_str: any, user_id_str: any)

Parameters

  • collection_str: any
  • key_str: any
  • user_id_str: any

create_api_read_storage_objects_request(object_ids_arr: any)

Parameters

  • object_ids_arr: any

create_api_rpc(http_key_str: any, id_str: any, payload_str: any)

Parameters

  • http_key_str: any
  • id_str: any
  • payload_str: any

create_api_session(created_bool: any, refresh_token_str: any, token_str: any)

Parameters

  • created_bool: any
  • refresh_token_str: any
  • token_str: any

create_api_session_logout_request(refresh_token_str: any, token_str: any)

Parameters

  • refresh_token_str: any
  • token_str: any

create_api_session_refresh_request(token_str: any, vars_obj: any)

Parameters

  • token_str: any
  • vars_obj: any

create_api_storage_object(collection_str: any, create_time_str: any, key_str: any, permission_read_int: any, permission_write_int: any, update_time_str: any, user_id_str: any, value_str: any, version_str: any)

Parameters

  • collection_str: any
  • create_time_str: any
  • key_str: any
  • permission_read_int: any
  • permission_write_int: any
  • update_time_str: any
  • user_id_str: any
  • value_str: any
  • version_str: any

create_api_storage_object_ack(collection_str: any, key_str: any, user_id_str: any, version_str: any)

Parameters

  • collection_str: any
  • key_str: any
  • user_id_str: any
  • version_str: any

create_api_storage_object_acks(acks_arr: any)

Parameters

  • acks_arr: any

create_api_storage_object_list(cursor_str: any, objects_arr: any)

Parameters

  • cursor_str: any
  • objects_arr: any

create_api_storage_objects(objects_arr: any)

Parameters

  • objects_arr: any

create_api_tournament(can_enter_bool: any, category_int: any, create_time_str: any, description_str: any, duration_int: any, end_active_int: any, end_time_str: any, id_str: any, max_num_score_int: any, max_size_int: any, metadata_str: any, next_reset_int: any, operator_api_operator: any, prev_reset_int: any, size_int: any, sort_order_int: any, start_active_int: any, start_time_str: any, title_str: any)

Parameters

  • can_enter_bool: any
  • category_int: any
  • create_time_str: any
  • description_str: any
  • duration_int: any
  • end_active_int: any
  • end_time_str: any
  • id_str: any
  • max_num_score_int: any
  • max_size_int: any
  • metadata_str: any
  • next_reset_int: any
  • operator_api_operator: any
  • prev_reset_int: any
  • size_int: any
  • sort_order_int: any
  • start_active_int: any
  • start_time_str: any
  • title_str: any

create_api_tournament_list(cursor_str: any, tournaments_arr: any)

Parameters

  • cursor_str: any
  • tournaments_arr: any

create_api_tournament_record_list(next_cursor_str: any, owner_records_arr: any, prev_cursor_str: any, records_arr: any)

Parameters

  • next_cursor_str: any
  • owner_records_arr: any
  • prev_cursor_str: any
  • records_arr: any

create_api_update_account_request(avatar_url_str: any, display_name_str: any, lang_tag_str: any, location_str: any, timezone_str: any, username_str: any)

Parameters

  • avatar_url_str: any
  • display_name_str: any
  • lang_tag_str: any
  • location_str: any
  • timezone_str: any
  • username_str: any

create_api_update_group_request(avatar_url_str: any, description_str: any, group_id_str: any, lang_tag_str: any, name_str: any, open_bool: any)

Parameters

  • avatar_url_str: any
  • description_str: any
  • group_id_str: any
  • lang_tag_str: any
  • name_str: any
  • open_bool: any

create_api_user(apple_id_str: any, avatar_url_str: any, create_time_str: any, display_name_str: any, edge_count_int: any, facebook_id_str: any, facebook_instant_game_id_str: any, gamecenter_id_str: any, google_id_str: any, id_str: any, lang_tag_str: any, location_str: any, metadata_str: any, online_bool: any, steam_id_str: any, timezone_str: any, update_time_str: any, username_str: any)

Parameters

  • apple_id_str: any
  • avatar_url_str: any
  • create_time_str: any
  • display_name_str: any
  • edge_count_int: any
  • facebook_id_str: any
  • facebook_instant_game_id_str: any
  • gamecenter_id_str: any
  • google_id_str: any
  • id_str: any
  • lang_tag_str: any
  • location_str: any
  • metadata_str: any
  • online_bool: any
  • steam_id_str: any
  • timezone_str: any
  • update_time_str: any
  • username_str: any

create_api_user_group_list(cursor_str: any, user_groups_arr: any)

Parameters

  • cursor_str: any
  • user_groups_arr: any

create_api_users(users_arr: any)

Parameters

  • users_arr: any

create_api_validate_purchase_apple_request(receipt_str: any)

Parameters

  • receipt_str: any

create_api_validate_purchase_google_request(purchase_str: any)

Parameters

  • purchase_str: any

create_api_validate_purchase_huawei_request(purchase_str: any, signature_str: any)

Parameters

  • purchase_str: any
  • signature_str: any

create_api_validate_purchase_response(validated_purchases_arr: any)

Parameters

  • validated_purchases_arr: any

create_api_validated_purchase(create_time_str: any, environment_validated_purchase_environment: any, product_id_str: any, provider_response_str: any, purchase_time_str: any, store_validated_purchase_store: any, transaction_id_str: any, update_time_str: any)

Parameters

  • create_time_str: any
  • environment_validated_purchase_environment: any
  • product_id_str: any
  • provider_response_str: any
  • purchase_time_str: any
  • store_validated_purchase_store: any
  • transaction_id_str: any
  • update_time_str: any

create_api_write_storage_object(collection_str: any, key_str: any, permission_read_int: any, permission_write_int: any, value_str: any, version_str: any)

Parameters

  • collection_str: any
  • key_str: any
  • permission_read_int: any
  • permission_write_int: any
  • value_str: any
  • version_str: any

create_api_write_storage_objects_request(objects_arr: any)

Parameters

  • objects_arr: any

create_protobuf_any(type_url_str: any, value_str: any)

Parameters

  • type_url_str: any
  • value_str: any

create_rpc_status(code_int: any, details_arr: any, message_str: any)

Parameters

  • code_int: any
  • details_arr: any
  • message_str: any

on_notification(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_matchdata(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_matchpresence(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_matchmakermatched(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_statuspresence(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_streampresence(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_streamdata(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_channelmessage(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_channelpresence(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

on_disconnect(socket: any, fn: any)

Parameters

  • socket: any
  • fn: any

create_socket(client: any)

Parameters

  • client: any

socket_connect(socket: any, callback: any)

Parameters

  • socket: any
  • callback: any

socket_send(socket: any, message: string, callback: any)

Parameters

  • socket: any
  • message: string
  • callback: any

healthcheck(client: any, callback: any)

Parameters

  • client: any
  • callback: any

get_account(client: any, callback: any)

Parameters

  • client: any
  • callback: any

update_account(client: any, body_api_update_account_request: any, callback: any)

Parameters

  • client: any
  • body_api_update_account_request: any
  • callback: any

authenticate_apple(client: any, body_api_account_apple: any, create_bool: any, username_str: any, callback: any)

Parameters

  • client: any
  • body_api_account_apple: any
  • create_bool: any
  • username_str: any
  • callback: any

authenticate_device(client: any, body_api_account_device: any, create_bool: any, username_str: any, callback: any)

Parameters

  • client: any
  • body_api_account_device: any
  • create_bool: any
  • username_str: any
  • callback: any

authenticate_email(client: any, body_api_account_email: any, create_bool: any, username_str: any, callback: any)

Parameters

  • client: any
  • body_api_account_email: any
  • create_bool: any
  • username_str: any
  • callback: any

authenticate_facebook(client: any, body_api_account_facebook: any, create_bool: any, username_str: any, sync_bool: any, callback: any)

Parameters

  • client: any
  • body_api_account_facebook: any
  • create_bool: any
  • username_str: any
  • sync_bool: any
  • callback: any

authenticate_facebook_instant_game(client: any, body_api_account_facebook_instant_game: any, create_bool: any, username_str: any, callback: any)

Parameters

  • client: any
  • body_api_account_facebook_instant_game: any
  • create_bool: any
  • username_str: any
  • callback: any

authenticate_game_center(client: any, body_api_account_game_center: any, create_bool: any, username_str: any, callback: any)

Parameters

  • client: any
  • body_api_account_game_center: any
  • create_bool: any
  • username_str: any
  • callback: any

authenticate_google(client: any, body_api_account_google: any, create_bool: any, username_str: any, callback: any)

Parameters

  • client: any
  • body_api_account_google: any
  • create_bool: any
  • username_str: any
  • callback: any

authenticate_steam(client: any, body_api_account_steam: any, create_bool: any, username_str: any, sync_bool: any, callback: any)

Parameters

  • client: any
  • body_api_account_steam: any
  • create_bool: any
  • username_str: any
  • sync_bool: any
  • callback: any

link_apple(client: any, body_api_account_apple: any, callback: any)

Parameters

  • client: any
  • body_api_account_apple: any
  • callback: any

link_custom(client: any, body_api_account_custom: any, callback: any)

Parameters

  • client: any
  • body_api_account_custom: any
  • callback: any

link_device(client: any, body_api_account_device: any, callback: any)

Parameters

  • client: any
  • body_api_account_device: any
  • callback: any

link_email(client: any, body_api_account_email: any, callback: any)

Parameters

  • client: any
  • body_api_account_email: any
  • callback: any

link_facebook(client: any, body_api_account_facebook: any, sync_bool: any, callback: any)

Parameters

  • client: any
  • body_api_account_facebook: any
  • sync_bool: any
  • callback: any

link_facebook_instant_game(client: any, body_api_account_facebook_instant_game: any, callback: any)

Parameters

  • client: any
  • body_api_account_facebook_instant_game: any
  • callback: any

link_game_center(client: any, body_api_account_game_center: any, callback: any)

Parameters

  • client: any
  • body_api_account_game_center: any
  • callback: any

link_google(client: any, body_api_account_google: any, callback: any)

Parameters

  • client: any
  • body_api_account_google: any
  • callback: any

link_steam(client: any, body_api_link_steam_request: any, callback: any)

Parameters

  • client: any
  • body_api_link_steam_request: any
  • callback: any

session_refresh(client: any, body_api_session_refresh_request: any, callback: any)

Parameters

  • client: any
  • body_api_session_refresh_request: any
  • callback: any

unlink_apple(client: any, body_api_account_apple: any, callback: any)

Parameters

  • client: any
  • body_api_account_apple: any
  • callback: any

unlink_custom(client: any, body_api_account_custom: any, callback: any)

Parameters

  • client: any
  • body_api_account_custom: any
  • callback: any

unlink_device(client: any, body_api_account_device: any, callback: any)

Parameters

  • client: any
  • body_api_account_device: any
  • callback: any

unlink_email(client: any, body_api_account_email: any, callback: any)

Parameters

  • client: any
  • body_api_account_email: any
  • callback: any

unlink_facebook(client: any, body_api_account_facebook: any, callback: any)

Parameters

  • client: any
  • body_api_account_facebook: any
  • callback: any

unlink_facebook_instant_game(client: any, body_api_account_facebook_instant_game: any, callback: any)

Parameters

  • client: any
  • body_api_account_facebook_instant_game: any
  • callback: any

unlink_game_center(client: any, body_api_account_game_center: any, callback: any)

Parameters

  • client: any
  • body_api_account_game_center: any
  • callback: any

unlink_google(client: any, body_api_account_google: any, callback: any)

Parameters

  • client: any
  • body_api_account_google: any
  • callback: any

unlink_steam(client: any, body_api_account_steam: any, callback: any)

Parameters

  • client: any
  • body_api_account_steam: any
  • callback: any

list_channel_messages(client: any, channel_id_str: any, limit_int: number, forward_bool: any, cursor_str: any, callback: any)

Parameters

  • client: any
  • channel_id_str: any
  • limit_int: number
  • forward_bool: any
  • cursor_str: any
  • callback: any

event(client: any, body_api_event: any, callback: any)

Parameters

  • client: any
  • body_api_event: any
  • callback: any

delete_friends(client: any, ids_arr: any, usernames_arr: any, callback: any)

Parameters

  • client: any
  • ids_arr: any
  • usernames_arr: any
  • callback: any

list_friends(client: any, limit_int: number, state_int: any, cursor_str: any, callback: any)

Parameters

  • client: any
  • limit_int: number
  • state_int: any
  • cursor_str: any
  • callback: any

add_friends(client: any, ids_arr: any, usernames_arr: any, callback: any)

Parameters

  • client: any
  • ids_arr: any
  • usernames_arr: any
  • callback: any

block_friends(client: any, ids_arr: any, usernames_arr: any, callback: any)

Parameters

  • client: any
  • ids_arr: any
  • usernames_arr: any
  • callback: any

import_facebook_friends(client: any, body_api_account_facebook: any, reset_bool: any, callback: any)

Parameters

  • client: any
  • body_api_account_facebook: any
  • reset_bool: any
  • callback: any

import_steam_friends(client: any, body_api_account_steam: any, reset_bool: any, callback: any)

Parameters

  • client: any
  • body_api_account_steam: any
  • reset_bool: any
  • callback: any

list_groups(client: any, name_str: any, cursor_str: any, limit_int: number, lang_tag_str: any, members_int: any, open_bool: any, callback: any)

Parameters

  • client: any
  • name_str: any
  • cursor_str: any
  • limit_int: number
  • lang_tag_str: any
  • members_int: any
  • open_bool: any
  • callback: any

create_group(client: any, body_api_create_group_request: any, callback: any)

Parameters

  • client: any
  • body_api_create_group_request: any
  • callback: any

delete_group(client: any, group_id_str: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • callback: any

update_group(client: any, group_id_str: any, body_api_update_group_request: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • body_api_update_group_request: any
  • callback: any

add_group_users(client: any, group_id_str: any, user_ids_arr: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • user_ids_arr: any
  • callback: any

ban_group_users(client: any, group_id_str: any, user_ids_arr: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • user_ids_arr: any
  • callback: any

demote_group_users(client: any, group_id_str: any, user_ids_arr: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • user_ids_arr: any
  • callback: any

join_group(client: any, group_id_str: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • callback: any

kick_group_users(client: any, group_id_str: any, user_ids_arr: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • user_ids_arr: any
  • callback: any

leave_group(client: any, group_id_str: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • callback: any

promote_group_users(client: any, group_id_str: any, user_ids_arr: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • user_ids_arr: any
  • callback: any

list_group_users(client: any, group_id_str: any, limit_int: number, state_int: any, cursor_str: any, callback: any)

Parameters

  • client: any
  • group_id_str: any
  • limit_int: number
  • state_int: any
  • cursor_str: any
  • callback: any

validate_purchase_apple(client: any, body_api_validate_purchase_apple_request: any, callback: any)

Parameters

  • client: any
  • body_api_validate_purchase_apple_request: any
  • callback: any

validate_purchase_google(client: any, body_api_validate_purchase_google_request: any, callback: any)

Parameters

  • client: any
  • body_api_validate_purchase_google_request: any
  • callback: any

validate_purchase_huawei(client: any, body_api_validate_purchase_huawei_request: any, callback: any)

Parameters

  • client: any
  • body_api_validate_purchase_huawei_request: any
  • callback: any

delete_leaderboard_record(client: any, leaderboard_id_str: any, callback: any)

Parameters

  • client: any
  • leaderboard_id_str: any
  • callback: any

list_leaderboard_records(client: any, leaderboard_id_str: any, owner_ids_arr: any, limit_int: number, cursor_str: any, expiry_str: any, callback: any)

Parameters

  • client: any
  • leaderboard_id_str: any
  • owner_ids_arr: any
  • limit_int: number
  • cursor_str: any
  • expiry_str: any
  • callback: any

write_leaderboard_record(client: any, leaderboard_id_str: any, body_write_leaderboard_record_request_leaderboard_record_write: any, callback: any)

Parameters

  • client: any
  • leaderboard_id_str: any
  • body_write_leaderboard_record_request_leaderboard_record_write: any
  • callback: any

list_leaderboard_records_around_owner(client: any, leaderboard_id_str: any, owner_id_str: any, limit_int: number, expiry_str: any, callback: any)

Parameters

  • client: any
  • leaderboard_id_str: any
  • owner_id_str: any
  • limit_int: number
  • expiry_str: any
  • callback: any

list_matches(client: any, limit_int: number, authoritative_bool: any, label_str: any, min_size_int: any, max_size_int: any, query_str: any, callback: any)

Parameters

  • client: any
  • limit_int: number
  • authoritative_bool: any
  • label_str: any
  • min_size_int: any
  • max_size_int: any
  • query_str: any
  • callback: any

delete_notifications(client: any, ids_arr: any, callback: any)

Parameters

  • client: any
  • ids_arr: any
  • callback: any

list_notifications(client: any, limit_int: number, cacheable_cursor_str: any, callback: any)

Parameters

  • client: any
  • limit_int: number
  • cacheable_cursor_str: any
  • callback: any

rpc_func2(client: any, id_str: any, payload_str: any, http_key_str: any, callback: any)

Parameters

  • client: any
  • id_str: any
  • payload_str: any
  • http_key_str: any
  • callback: any

rpc_func(client: any, id_str: any, body_: any, http_key_str: any, callback: any)

Parameters

  • client: any
  • id_str: any
  • body_: any
  • http_key_str: any
  • callback: any

session_logout(client: any, body_api_session_logout_request: any, callback: any)

Parameters

  • client: any
  • body_api_session_logout_request: any
  • callback: any

read_storage_objects(client: any, body_api_read_storage_objects_request: any, callback: any)

Parameters

  • client: any
  • body_api_read_storage_objects_request: any
  • callback: any

write_storage_objects(client: any, body_api_write_storage_objects_request: any, callback: any)

Parameters

  • client: any
  • body_api_write_storage_objects_request: any
  • callback: any

delete_storage_objects(client: any, body_api_delete_storage_objects_request: any, callback: any)

Parameters

  • client: any
  • body_api_delete_storage_objects_request: any
  • callback: any

list_storage_objects(client: any, collection_str: any, user_id_str: any, limit_int: number, cursor_str: any, callback: any)

Parameters

  • client: any
  • collection_str: any
  • user_id_str: any
  • limit_int: number
  • cursor_str: any
  • callback: any

list_storage_objects2(client: any, collection_str: any, user_id_str: any, limit_int: number, cursor_str: any, callback: any)

Parameters

  • client: any
  • collection_str: any
  • user_id_str: any
  • limit_int: number
  • cursor_str: any
  • callback: any

list_tournaments(client: any, category_start_int: any, category_end_int: any, start_time_int: any, end_time_int: any, limit_int: number, cursor_str: any, callback: any)

Parameters

  • client: any
  • category_start_int: any
  • category_end_int: any
  • start_time_int: any
  • end_time_int: any
  • limit_int: number
  • cursor_str: any
  • callback: any

list_tournament_records(client: any, tournament_id_str: any, owner_ids_arr: any, limit_int: number, cursor_str: any, expiry_str: any, callback: any)

Parameters

  • client: any
  • tournament_id_str: any
  • owner_ids_arr: any
  • limit_int: number
  • cursor_str: any
  • expiry_str: any
  • callback: any

write_tournament_record2(client: any, tournament_id_str: any, body_write_tournament_record_request_tournament_record_write: any, callback: any)

Parameters

  • client: any
  • tournament_id_str: any
  • body_write_tournament_record_request_tournament_record_write: any
  • callback: any

write_tournament_record(client: any, tournament_id_str: any, body_write_tournament_record_request_tournament_record_write: any, callback: any)

Parameters

  • client: any
  • tournament_id_str: any
  • body_write_tournament_record_request_tournament_record_write: any
  • callback: any

join_tournament(client: any, tournament_id_str: any, callback: any)

Parameters

  • client: any
  • tournament_id_str: any
  • callback: any

list_tournament_records_around_owner(client: any, tournament_id_str: any, owner_id_str: any, limit_int: number, expiry_str: any, callback: any)

Parameters

  • client: any
  • tournament_id_str: any
  • owner_id_str: any
  • limit_int: number
  • expiry_str: any
  • callback: any

get_users(client: any, ids_arr: any, usernames_arr: any, facebook_ids_arr: any, callback: any)

Parameters

  • client: any
  • ids_arr: any
  • usernames_arr: any
  • facebook_ids_arr: any
  • callback: any

list_user_groups(client: any, user_id_str: any, limit_int: number, state_int: any, cursor_str: any, callback: any)

Parameters

  • client: any
  • user_id_str: any
  • limit_int: number
  • state_int: any
  • cursor_str: any
  • callback: any

Types

Session.token: SessionToken

Session.refresh_token: SessionToken

Session.created: boolean

ClientConfig.host: string

ClientConfig.port: number

ClientConfig.use_ssl: boolean

ClientConfig.username: string

ClientConfig.password: string

ClientConfig.engine: unknown