For the complete documentation index, see llms.txt. This page is also available as Markdown.

Login

Login

After initialization is complete, you can log in by entering your username, name, and profile image address (optional).

Access

await nc.Connect(
    id: [USERNAME],
    name: [NAME],
    profile: [PROFILE_URL],
    customField: [CUSTOM_FIELD],
    token: [TOKEN]
);
ID
Type
Description
Required

USERNAME

string

ID

O

NAME

string

Nickname

X

PROFILE_URL

string

Profile address URL

X

LANGUAGE

string

Language code

X

CUSTOM_FIELD

string

User-defined field

X

TOKEN

string

Token value

X

Note

  • Obtain a token through the API for log-in security.

  • API DOCS TOKEN lets you use a token issued through the API.

  • If you do not want to use the token method, set disable in Dashboard > Security settings > Token authentication.

Terminate access

Use the code below to disconnect from the connected Game Chat server.

User information

  • Member Data Class

ID
Type
Description

id

string

User ID

name

string

Username

profile

string

Image address

Import user information

Gets information about a specific ID (only the nickname is sent for security reasons).

  • Parameters

ID
Type
Description
Required

filter

object

Search is available for all fields of a query through filtering

O

sort

object

Define the filter for the fields you want to sort (ascending order "1", descending order "-1")

X

option

object

See the following when there are options

X

  • Options

ID
Type
Description

offset

number

Start offset

per_page

number

The number of returns (up to 100)

Last updated