Function Reference

1
2
3
4
5
6
7

let userId = '4ec4f126-3f9d-11e7-84ef-b7c182b36521';

try {
    nk.accountDeleteId(userId, false);
} catch (error) {
    // handle error
}

1
2
3
4
5
6
7

let userId = '4ec4f126-3f9d-11e7-84ef-b7c182b36521';

try {
    let accountJson = nk.accountExportId(userId);
} catch (error) {
    // handle error
}

1
2
3
4
5
6
7

let userId = '4ec4f126-3f9d-11e7-84ef-b7c182b36521';

try {
    let account = nk.accountGetId(userId);
} catch (error) {
    // handle error
}

1
2
3
4
5
6
7

let userIds = ['4ec4f126-3f9d-11e7-84ef-b7c182b36521', '6134d1cf-4b55-497f-b9e9-fc5090b76475'];

try {
    let accounts = nk.accountsGetId(userIds);
} catch (error) {
    // handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

let userId = '4ec4f126-3f9d-11e7-84ef-b7c182b36521';
let username = null;
let metadata = {pro: true};
let displayName = 'new display name';
let timezone = null;
let location = null;
let langTag = null;
let avatarUrl = null;

try {
    nk.accountUpdateId(userId, username, displayName, timezone, location, langTag, avatarUrl, metadata);
} catch (error) {
    // handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateApple('some-oauth-access-token', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateCustom('48656C6C6F20776F726C64', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateDevice('48656C6C6F20776F726C64', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateEmail('email@example.com', 'password', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateFacebook('some-oauth-access-token', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateFacebookInstantGame('player-info', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7
8

let result = {} as nkruntime.AuthResult;

try {
    // Example assumes arguments are defined.
    result = nk.authenticateGameCenter(playerId, bundleId, timestamp, salt, signature, publicKeyUrl, username, create);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateGoogle('some-id-token', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.AuthResult;

try {
    result = nk.authenticateSteam('steam-token', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7

let result = {} as nkruntime.TokenGenerateResult;

try {
    result = nk.authenticateTokenGenerate('steam-token', 'username', true);
} catch (error) {
    // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let token = '<Token>';

try {
  nk.linkApple(userId, token);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let customId = '<CustomId>';

try {
  nk.linkCustom(userId, customId);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let deviceId = '<Deviceid>';

try {
  nk.linkDevice(userId, deviceId);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8
9

let userId = '<UserId>';
let email = 'test@heroiclabs.com';
let password = 'correct horse battery staple'

try {
  nk.linkEmail(userId, email, password);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

let userId = '<UserId>';
let username = '<Username>';
let token = '<Token>';
let importFriends = true;

try {
  nk.linkFacebook(userId, username, token, importFriends);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let signedPlayerInfo = '<SignedPlayerInfo>';

try {
  nk.linkFacebookInstantGame(userId, signedPlayerInfo);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

let userId = '<UserId>';
let playerId = '<PlayerId>';
let bundleId = '<BundleId>';
let timestamp = 0;
let salt = "<Salt>";
let signature = "<Signature>";
let publicKeyUrl = "<PublicKeyUrl>";

try {
  nk.linkGameCenter(userId, playerId, bundleId, timestamp, salt, signature, publicKeyUrl);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let token = '<Token>';

try {
  nk.linkGoogle(userId, token);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

let userId = '<UserId>';
let username = '<Username>';
let token = '<Token>';
let importFriends = true;

try {
  nk.linkSteam(userId, username, token, importFriends);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let token = '<Token>';

try {
  nk.unlinkApple(userId, token);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let customId = '<CustomId>';

try {
  nk.unlinkCustom(userId, customId);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let deviceId = '<Deviceid>';

try {
  nk.unlinkDevice(userId, deviceId);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let email = 'test@heroiclabs.com';

try {
  nk.unlinkEmail(userId, email);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let token = '<Token>';

try {
  nk.unlinkFacebook(userId, token);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let signedPlayerInfo = '<SignedPlayerInfo>';

try {
  nk.unlinkFacebookInstantGame(userId, signedPlayerInfo);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

let userId = '<UserId>';
let playerId = '<PlayerId>';
let bundleId = '<BundleId>';
let timestamp = 0;
let salt = "<Salt>";
let signature = "<Signature>";
let publicKeyUrl = "<PublicKeyUrl>";

try {
  nk.unlinkGameCenter(userId, playerId, bundleId, timestamp, salt, signature, publicKeyUrl);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let token = '<Token>';

try {
  nk.unlinkGoogle(userId, token);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let userId = '<UserId>';
let token = '<Token>';

try {
  nk.unlinkSteam(userId, token);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7

let result: string;

try {
  result = nk.channelIdBuild('<SenderId>', '<RoomName>', nkruntime.ChannelType.Room);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

let result: nkruntime.ChannelMessageAck;
let channelId = '<ChannelId>';
let messageId = '<MessageId>';
let senderId = '<SenderId>';
let senderUsername = 'Someone';
let persist = true;

try {
  result = nk.channelMessageRemove(channelId, messageId, senderId, senderUsername, persist);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

let result: nkruntime.ChannelMessageSendAck;
let channelId = '<ChannelId>';
let content = { message: 'Hello world' };
let senderId = '<SenderId>';
let senderUsername = 'Someone';
let persist = true;

try {
  result = nk.channelMessageSend(channelId, content, senderId, senderUsername, persist);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let messages = {} as nkruntime.ChannelMessageList;

try {
  let channelId = "<channelId>";
  messages = nk.channelMessagesList(channelId);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

let result: nkruntime.ChannelMessageSendAck;
let channelId = '<ChannelId>';
let messageId = '<MessageId>';
let content = { message: 'Hello another world' };
let senderId = '<SenderId>';
let senderUsername = 'Someone';
let persist = true;

try {
  result = nk.channelMessageUpdate(channelId, messageId, content, senderId, senderUsername, persist);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

let eventName = '<EventName>';
let properties = [ 'properties' ];
let timestamp = 0;
let external = true;

try {
  nk.event(eventName, properties, timestamp, external);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

let userId = "b1aafe16-7540-11e7-9738-13777fcc7cd8"
let friendId = "9a51cf3a-2377-11eb-b713-e7d403afe081"
let metadata = {
    note: "My best friend."
} 

try {
  nk.friendMetadataUpdate(userId, friendId, metadata);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

let userId = "b1aafe16-7540-11e7-9738-13777fcc7cd8";
let username = "username";
let userIds = ['9a51cf3a-2377-11eb-b713-e7d403afe081', 'a042c19c-2377-11eb-b7c1-cfafae11cfbc'];
let usernames = ["newfriend1", "newfriend2"];

try {
  nk.friendsAdd(userId, username, userIds, usernames);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

let userId = "b1aafe16-7540-11e7-9738-13777fcc7cd8";
let username = "username";
let userIds = ['9a51cf3a-2377-11eb-b713-e7d403afe081', 'a042c19c-2377-11eb-b7c1-cfafae11cfbc'];
let usernames = ["exfriend1", "exfriend2"];

try {
  nk.friendsBlock(userId, username, userIds, usernames);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

let userId = "b1aafe16-7540-11e7-9738-13777fcc7cd8";
let username = "username";
let userIds = ['9a51cf3a-2377-11eb-b713-e7d403afe081', 'a042c19c-2377-11eb-b7c1-cfafae11cfbc'];
let usernames = ["exfriend1", "exfriend2"];

try {
  nk.friendsDelete(userId, username, userIds, usernames);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

let friends = {} as nkruntime.FriendList;

try {
  let userId = 'b1aafe16-7540-11e7-9738-13777fcc7cd8';
  let limit = 100;
  let state = 0;
  friends = nk.friendsList(userId, limit, state);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8
9

let friends = {} as nkruntime.FriendList;

try {
  let userId = "b1aafe16-7540-11e7-9738-13777fcc7cd8";
  let limit = 100;
  friends = nk.friendsOfFriendsList(userId, limit);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

let userId = 'dcb891ea-a311-4681-9213-6741351c9994';
let creatorId = 'dcb891ea-a311-4681-9213-6741351c9994';
let name = 'Some unique group name';
let description = 'My awesome group.';
let lang = 'en';
let open = true;
let avatarURL = 'url://somelink';
let metadata = { custom_field: 'some_value' };
let maxCount = 100;

let group = {} as nkruntime.Group;
try {
  group = nk.groupCreate(userId, name, creatorId, lang, description, avatarURL, open, metadata, maxCount);
} catch (error) {
  // Handle error
}

1
2
3
4
5

try {
  nk.groupDelete('f00fa79a-750f-11e7-8626-0fb79f45ff97');
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8

let groups: nkruntime.Group[];

try {
  let groupIds = ['dcb891ea-a311-4681-9213-6741351c9994'];
  groups = nk.groupsGetId(groupIds);
} catch (error) {
  // Handle error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

let groupName = "Heroic";
let langTag = "en";
let members = 10;
let open = true;
let limit = 100;

let results: nkruntime.GroupList = {};
try {
  results = nk.groupsList(groupName, langTag, open, members, limit);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8
9

let metadata = { someField: 'some value' };
let groupId = 'f00fa79a-750f-11e7-8626-0fb79f45ff97';
let description = 'An updated description';

try {
  nk.groupUpdate(groupId, null, null, null, null, description, null, true, metadata);
} catch (error) {
  // Handle error.
}

1
2
3
4
5
6
7
8
9

let groupId = 'dcb891ea-a311-4681-9213-6741351c9994';
let userId = '9a51cf3a-2377-11eb-b713-e7d403afe081';
let username = 'myusername';

try {
  nk.groupUserJoin(groupId, userId, username);
} catch (error) {
  // Handle error
}

1
2
3
4
5
6
7
8
9