CreateNickname
public BackendReturnObject CreateNickname(string nickname);
Parameter
Value | Type | Description |
---|---|---|
nickname | string | Value of nickname. Up to 20 characters. Blanks cannot be added before or after the nickname. |
Description
This function is used to create or modify nicknames.
Nicknames can be also modified by calling the nickname creation method.
Example
Synchronous
Backend.BMember.CreateNickname("thebackend");
Asynchronous
Backend.BMember.CreateNickname("thebackend", (callback) =>
{
// Post-process
});
SendQueue
SendQueue.Enqueue(Backend.BMember.CreateNickname, "thebackend", (callback) =>
{
// Post-process
});
Return cases
Success cases
When the creation/modification is successful
statusCode : 204
message : Success
Error cases
When the user tries to create/modify a nickname using an empty nickname or string.empty
statusCode : 400
errorCode : UndefinedParameterException
message : undefined nickname, nickname cannot be checked
When the nickname exceeds 20 characters
statusCode : 400
errorCode : BadParameterException
message : bad nickname is too long, The nickname is too long
When there is a blank before/after the nickname
statusCode : 400
errorCode : BadParameterException
message : bad beginning or end of the nickname must not be blank , The beginning or end of the nickname must not be a blank
When there is a duplicated nickname
statusCode : 409
errorCode : DuplicatedParameterException
message : Duplicated nickname, Duplicated nickname