Open channel

OpenChannel.createChannel(NAME, COVER_IMAGE_OR_URL, DATA, OPERATOR_IDS, CUSTOM_TYPE, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    // An open channel is successfully created.
    // Through the "openChannel" parameter of the callback function,
    // you can get the open channel's data from the result object that Sendbird server has passed to the callback function.
    const channelUrl = openChannel.channelUrl;
    ...
});

var params = new sb.OpenChannelParams();
params.name = NAME;
params.coverUrlOrImage = FILE | COVER_URL;
params.operatorUserIds = ['Hoon', 'Doo']; // Or .operators(Array<User>)
params.data = DATA;
params.customType = CUSTOM_TYPE;
params.channelUrl = UNIQUE_CHANNEL_URL; // For an open channel, you can create a channel by specifying its unique channel URL in a `OpenChannelParams` object.

sb.OpenChannel.createChannel(params, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    // An open channel with detailed configuration is successfully created.
    // By using openChannel.channelUrl, openChannel.data, openChannel.customType, and so on,
    // you can access the result object from Sendbird server to check your OpenChannelParams configuration.
    const channelUrl = openChannel.channelUrl;
    ...
});

sb.OpenChannel.getChannel(CHANNEL_URL, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    // Call the instance method of the result object in the "openChannel" parameter of the callback function.
    openChannel.enter(function(response, error) {
        if (error) {
            // Handle error.
        }

        // The current user successfully enters the open channel,
        // and can chat with other users in the channel by using APIs.
        ...
    });
});

sb.OpenChannel.getChannel(CHANNEL_URL, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    openChannel.exit(function(response, error) {
        if (error) {
            // Handle error.
        }

        // The current user successfully exits the open channel,
        ...
    });
});

sb.OpenChannel.getChannel(CHANNEL_URL, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    openChannel.delete(function(response, error) {
        if (error) {
            // Handle error.
        }

        // The channel is successfully deleted.
        ...
    });
});

var listQuery = sb.OpenChannel.createOpenChannelListQuery();

listQuery.next(function(openChannels, error) {
    if (error) {
        // Handle error.
    }

    // A list of open channels is successfully retrieved.
    // Through the "openChannels" parameter of the callback function,
    // you can access the data of each open channel from the result list that Sendbird server has passed to the callback function.
    openChannels.forEach(channel => {
        ...
    });

    ...
});

sb.OpenChannel.getChannel(CHANNEL_URL, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    // Through the "openChannel" parameter of the callback function,
    // the open channel object identified with the CHANNEL_URL is returned by Sendbird server,
    // and you can get the open channel's data from the result object.
    const channelName = openChannel.name;
    ...
});

const params = new sb.UserMessageParams();

params.message = TEXT_MESSAGE;
params.customType = CUSTOM_TYPE;
params.data = DATA;
params.mentionType = 'users';                       // Either 'users' or 'channel'
params.mentionedUserIds = ['Jeff', 'Julia'];        // Or mentionedUsers = Array<User>;
params.metaArrays = [   // A pair of key-value
    new sendBirds.me.MessageMetaArray('itemType', ['tablet']),
    new sendBirds.me.MessageMetaArray('quality', ['best', 'good'])
];
params.translationTargetLanguages = ['fe', 'de'];   // French and German
params.pushNotificationDeliveryOption = 'default';  // Either 'default' or 'suppress'

openChannel.sendUserMessage(params, function(userMessage, error) {
    if (error) {
        // Handle error.
    }

    // A text message with detailed configuration is successfully sent to the channel.
    // By using userMessage.messageId, userMessage.message, userMessage.customType, and so on,
    // you can access the result object from Sendbird server to check your UserMessageParams configuration.
    // The current user can receive messages from other users through the onMessageReceived() method of an event handler.
    const messageId = userMessage.messageId;
    ...
});

// Sending a file message with a raw file
const params = new sb.FileMessageParams();

params.file = FILE;             // Or .fileUrl = FILE_URL (You can also send a file message with a file URL.)
params.fileName = FILE_NAME;
params.fileSize = FILE_SIZE;
params.thumbnailSizes = [{maxWidth: 100, maxHeight: 100}, {maxWidth: 200, maxHeight: 200}]; // Add the maximum sizes of thumbnail images (allowed number of thumbnail images: 3).
params.mimeType = MIME_TYPE;
params.customType = CUSTOM_TYPE;
params.mentionType = 'users';                       // Either 'users' or 'channel'
params.mentionedUserIds = ['Jeff', 'Julia'];        // Or mentionedUsers = Array<User>;
params.pushNotificationDeliveryOption = 'default';  // Either 'default' or 'suppress'

openChannel.sendFileMessage(params, function(fileMessage, error) {
    if (error) {
        // Handle error.
    }

    // A file message with detailed configuration is successfully sent to the channel.
    // By using fileMessage.messageId, fileMessage.fileName, fileMessage.customType, and so on,
    // you can access the result object from Sendbird server to check your FileMessageParams configuration.
    // The current user can receive messages from other users through the onMessageReceived() method of an event handler.
    const messageId = fileMessage.messageId;
    ...
});

var channelHandler = new sb.ChannelHandler();

channelHandler.onMessageReceived = function(channel, message) {
    ...
};

sb.addChannelHandler(UNIQUE_HANDLER_ID, channelHandler);

// Create a `UserMessageParams` object.
const params = new sb.UserMessageParams();
params.parentMessageId = PARENT_MESSAGE_ID; // This specifies the unique ID of a parent message which has a thread of replies. If the message sent through the `sendUserMessage()` method is a parent message, the value of this property is 0.
...

// Pass the params to the parameter of the `sendUserMessage()` method.
channel.sendUserMessage(params, (message, error) => {
    if (error) {
        // Handle error.
    }

    // A reply to a specific message in the form of a text message is successfully sent.
    ...
});

// Create a `FileMessageParams` object.
const params = new sb.FileMessageParams();
params.file = FILE;
params.parentMessageId = PARENT_MESSAGE_ID; // This specifies the unique ID of a parent message which has a thread of replies. If the message sent through the `sendUserMessage()` method is a parent message, the value of this property is 0.
...

// Pass the params to the parameter in the `sendFileMessage()` method.
openChannel.sendFileMessage(params, (message, error) => {
    if (error) {
        // Handle error.
    }

    // A reply to a specific message in the form of a file message is successfully sent.
    ...
});

var params = new sb.UserMessageParams();
params.message = MESSAGE;
params.mentionedUserIds = ['Harry', 'Jay', 'Jin'];

openChannel.sendUserMessage(params, function(message, error) {
    if (error) {
        // Handle error.
    }

    ...
});

// There should only be one single instance per channel view.
var listQuery = openChannel.createPreviousMessageListQuery();
listQuery.limit = LIMIT;
listQuery.reverse = REVERSE;
listQuery.customType = CUSTOM_TYPE;
...

// Retrieving previous messages.
listQuery.load(function(messageList, error) {
    if (error) {
        // Handle error.
    }

    ...
});

const params = new sb.MessageListParams();
params.isInclusive = IS_INCLUSIVE;
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.shouldReverse = REVERSE;
params.messageType = MESSAGE_TYPE;
params.customType = CUSTOM_TYPE;
...

openChannel.getMessagesByTimestamp(TIMESTAMP, params, function(messages, error) {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified timestamp is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});

const params = new sb.MessageListParams();
params.isInclusive = IS_INCLUSIVE;
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.shouldReverse = REVERSE;
params.messageType = MESSAGE_TYPE;
params.customType = CUSTOM_TYPE;
...

openChannel.getMessagesByMessageId(MESSAGE_ID, params, function(messages, error) {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified message ID is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});

const listQuery = channel.createPreviousMessageListQuery();
listQuery.includeReplies = INCLUDE_REPLIES;
listQuery.includeThreadInfo = INCLUDE_THREAD_INFO;
listQuery.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;

// This retrieves previous messages in a channel.
listQuery.load(LIMIT, REVERSE, MESSAGE_TYPE_FILTER, (messages, error) => {
    if (error) {
        // Handle error.
    }

    ...
});

// Create a `MessageListParams` object.
const params = new sb.MessageListParams();
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.isInclusive = INCLUSIVE;
params.reverse = REVERSE;
params.includeReplies = INCLUDE_REPLIES;
params.includeThreadInfo = INCLUDE_THREAD_INFO;
params.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;
...

// Pass the params as an argument to the `getMessagesByTimestamp()` method.
openChannel.getMessagesByTimestamp(TIMESTAMP, params, (messages, error) => {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified timestamp is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});

// Create a `MessageListParams` object.
const params = new sb.MessageListParams();
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.isInclusive = INCLUSIVE;
params.reverse = REVERSE;
params.includeReplies = INCLUDE_REPLIES;
params.includeThreadInfo = INCLUDE_THREAD_INFO;
params.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;
...

// Pass the params as an argument to the `getMessagesByMessageId()` method.
openChannel.getMessagesByMessageId(MESSAGE_ID, params, (messages, error) => {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified message ID is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});

// Create a `ThreadMessageListParams` object.
const params = new sb.ThreadedMessageListParams();
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.isInclusive = INCLUSIVE;
params.reverse = REVERSE;
params.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;

// Pass the params as an argument to the parameter in the `getThreadedMessagesByTimestamp()` method.
parentMessage.getThreadedMessagesByTimestamp(TIMESTAMP, params, ({ parentMessage, threadedReplies }, error) => {
    if (error) {
        // Handle error.
    }

    // A list of replies of the specified parent message timestamp is successfully retrieved.
    ...
});

// Create a `MessageRetrievalParams` object.
const params = new sb.MessageRetrievalParams();
params.messageId = MESSAGE_ID;
params.channelType = CHANNEL_TYPE;
params.channelUrl = CHANNEL_URL;
...

// Pass the params as an argument to the parameter in the `getMessage()` method.
sb.BaseMessage.getMessage(params, (message, error) => {
    if (error) {
        // Handle error.
    }

    // The specified message is successfully retrieved.
    ...
});

var channelHandler = new sb.ChannelHandler();

channelHandler.onMessageUpdated = function(channel, message) {
    ...
};

sb.addChannelHandler(UNIQUE_HANDLER_ID, channelHandler);

// The MESSAGE below indicates a UserMessage or FileMessage object to delete.
openChannel.deleteMessage(MESSAGE, function(response, error) {
    if (error) {
        // Handle error.
    }

    // The message is successfully deleted from the channel.
    ...
});

var channelHandler = new sb.ChannelHandler();

channelHandler.onMessageDeleted = function(channel, messageId) {
    ...
};

sb.addChannelHandler(UNIQUE_HANDLER_ID, channelHandler);

var listQuery = openChannel.createParticipantListQuery();

listQuery.next(function(participantList, error) {
    if (error) {
        // Handle error.
    }

    ...
});

var listQuery = openChannel.createOperatorListQuery();

listQuery.next(function(operators, error) {
    if (error) {
        // Handle error.
    }

    ...
});

for(var operator in openChannel.operators) {
    ...
}

openChannel.addOperators(OPERATOR_USER_IDS, function(response, error) {
    if (error) {
        // Handle error.
    }

    // The participants are successfully registered as operators of the channel.
    ...
});

openChannel.removeOperators(OPERATOR_USER_IDS, function(response, error) {
    if (error) {
        // Handle error.
    }

    // The cancel operation is succeeded,
    // and you could display some message to those who are not operators anymore.
    ...
});

var listQuery = openChannel.createBannedUserListQuery();

bannedUserListQuery.next(function(userList, error) {
    if (error) {
        // Handle error.
    }

    ...
});

var listQuery = openChannel.createMutedUserListQuery();

listQuery.next(function(userList, error) {
    if (error) {
        // Handle error.
    }

    ...
});

sb.OpenChannel.getChannel(CHANNEL_URL, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    if (openChannel.isOperator(sb.currentUser)) {
        // Ban a user.
        openChannel.banUser(USER, SECONDS, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully banned from the channel.
            // You could notify the user of being banned by displaying a prompt.
            ...
        });

        // Unban a user.
        openChannel.unbanUser(USER, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully unbanned for the channel.
            // You could notify the user of being unbanned by displaying a prompt.
            ...
        });
    }
});

sb.OpenChannel.getChannel(CHANNEL_URL, function(openChannel, error) {
    if (error) {
        // Handle error.
    }

    if (openChannel.isOperator(sb.currentUser)) {
        // Mute a user.
        openChannel.muteUser(USER, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully muted in the channel.
            // You could notify the user of being muted by displaying a prompt.
            ...
        });

        // Unmute a user.
        openChannel.unmuteUser(USER, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully unmuted in the channel.
            // You could notify the user of being unmuted by displaying a prompt.
            ...
        });
    }
});

// Reporting a message.
openChannel.reportMessage(MESSAGE_TO_REPORT, REPORT_CATEGORY, DESCRIPTION, function(error) {
    if (error) {
        // Handle error.
    }

    ...
});

// Reporting a user.
openChannel.reportUser(OFFENDING_USER, REPORT_CATEGORY, DESCRIPTION, function(error) {
    if (error) {
        // Handle error.
    }

    ...
});

// Reporting a channel.
openChannel.report(REPORT_CATEGORY, DESCRIPTION, function(error) {
    if (error) {
        // Handle error.
    }

    ...
});