Login

Available in Classic and VPC

Login

Once the initialization is complete, you can enter the username, name, and profile image address (optional) to access.

Access

Javascript/TypeScript

await nc.connect({
    id: [USERNAME],
    name: [NAME],
    profile: [PROFILE_URL],
    language: [LANGUAGE],
    customField: [CUSTOM_FIELD],
    token: [TOKEN]
});

Android (Kotlin)

NChat.Connect([USERNAME], [NAME], [PROFILE_URL], [LANGUAGE], [CUSTOM_FIELD], [TOKEN]) { user, e ->
    if (e != null) {
        // Error
    } else {
        // Success
    }
}

iOS (Swift)

NChat.Connect(userId: [USER_ID], name: [NAME], profile: [PROFILE], customField: [CUSTOM_FIELD], token: [TOKEN]) { result in
    switch(result)
    {
    case .success(let user) :
        break;
    case .failure(let error) :
        break;
    }
}

iOS (Objective-C)

[NChatBridge.shared ConnectWithUserId:[USER_ID] name:[NAME] profile:[PROFILE] customField:[CUSTOM_FIELD] token:[TOKEN] :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
    if (error) {
        // Error
    } else {
        // Success
    }
}];

Unity

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

Terminate access

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

Javascript/Typescript

await nc.disconnect();

Android (Kotlin)

NChat.Disconnect();

iOS (Swift)

NChat.Disconnect() { result in
    switch(result)
    {
    case .success(let status) :
        break;
    case .failure(let error) :
        break;
    }
}

iOS (Objective-C)

[NChatBridge.shared Disconnect:^(NSNumber * _Nullable result, NSError * _Nullable error) {
    if (error) {
        // Error
    } else {
        // Success
    }
}];

Unity

await nc.Disconnect();

User information

• Member Data Class

Import user information

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

Javascript/Typescript

const filter = { id: user_id };
const sort = { created_at: -1 };
const option = { offset: 0, per_page: 100 };
const members = await nc.getUsers(filter, sort, option);

Android (Kotlin)

val filter: Map<String, Any?> = mapOf(
    "id" to [USER_ID]
)
val sort: Map<String, Any?> = mapOf(
    "created_at" to -1
)
val options: Map<String, Any?> = mapOf(
    "per_page" to 10,
    "offset" to 0
)
NChat.getUsers(filter, sort, options) { user, e->
    if (e != null) {
        // Error
    } else {
        // Succeeded
    }
}

iOS (Swift)

let filter: [String: Any] = ["id": [USER_ID]]
let option: [String: Any] = ["per_page": 10, "offset": 0]
let sort: [String: Any] = ["created_at": "-1"]
NChat.getUsers(filter: filter, option: option, sort: sort) { result in
    switch(result)
    {
    case .success(let messages) :
        // Succeeded
        break;
    case .failure(let error) :
        // Error
        break;
    }
}

iOS (Objective-C)

NSDictionary *filter = @{@"id": [USER_ID]};
NSDictionary *option = @{@"per_page": @10, @"offset": @0};
NSDictionary *sort = @{@"created_at": @"-1"};
[NChatBridge.shared getUsersWithFilter:filter option:option sort:sort :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
    if (error) {
        // Error
    } else {
        // Succeeded
    }
}];

Unity

Hashtable filter = new Hashtable
{
    { "id", [USER_ID] }
};
Hashtable sort = new Hashtable
{
    { "created_at", -1 }
};
Hashtable option = new Hashtable
{
    { "offset", 0 },
    { "per_page", 10 }
};
var users = await nc.getUsers(filter, sort, option);

• Parameters

• Options