core/com.cloudflare.realtimekit.chat/RtkChat

RtkChat

class RtkChat : PublicAPIEmitter<RtkChatEventListener>

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun getMessages(timestamp: Long, size: Int, offset: Int = 0, reversed: Boolean, onResult: (messagesResult: GetMessagesResult?, errorString: String?) -> Unit)

Gets chat messages in a paginated manner

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun sendFileMessage(@ObjCName(name = "fileURL") fileUri: RtkUri, onResult: (ChatFileError?) -> Unit)

Sends a file message to everyone.

fun sendFileMessage(@ObjCName(name = "fileURL") fileUri: RtkUri, peerIds: List<String>, onResult: (ChatFileError?) -> Unit)

Sends a file message to specific participants.

Link copied to clipboard
fun RtkChat.sendFileMessage(fileUri: Uri, onResult: (ChatFileError?) -> Unit)
fun RtkChat.sendFileMessage(fileUri: Uri, peerIds: List<String>, onResult: (ChatFileError?) -> Unit)
fun RtkChat.sendFileMessage(fileUri: NSURL, onResult: (ChatFileError?) -> Unit)
fun RtkChat.sendFileMessage(fileUri: NSURL, peerIds: List<String>, onResult: (ChatFileError?) -> Unit)
Link copied to clipboard
fun sendImageMessage(@ObjCName(name = "imageURL") imageUri: RtkUri, onResult: (ChatFileError?) -> Unit)

Sends an image message to everyone.

fun sendImageMessage(@ObjCName(name = "imageURL") imageUri: RtkUri, peerIds: List<String>, onResult: (ChatFileError?) -> Unit)

Sends an image message to specific participants.

Link copied to clipboard
fun RtkChat.sendImageMessage(imageUri: Uri, onResult: (ChatFileError?) -> Unit)
fun RtkChat.sendImageMessage(imageUri: Uri, peerIds: List<String>, onResult: (ChatFileError?) -> Unit)
fun RtkChat.sendImageMessage(imageUri: NSURL, onResult: (ChatFileError?) -> Unit)
fun RtkChat.sendImageMessage(imageUri: NSURL, peerIds: List<String>, onResult: (ChatFileError?) -> Unit)
Link copied to clipboard
fun sendTextMessage(message: String): ChatTextError?

Sends a string type chat message in the given room

fun sendTextMessage(message: String, peerIds: List<String>): ChatTextError?

Sends a TEXT message to specific participants.

Link copied to clipboard
fun setCharacterLimit(characterLimit: Int): ChatConfigError?

Sets the maximum number of characters allowed in a TEXT message.

Link copied to clipboard
fun setMessageRateLimit(maxMessages: Int, intervalInSeconds: Long): ChatConfigError?

Configures the rate limit for sending messages. This method allows setting the maximum number of messages that can be sent within a specified time interval. If the limit is reached within the interval, the user must wait until the interval period has passed before sending more messages. For example, if the interval is 60 seconds and the limit is reached in 30 seconds, the user must wait an additional 30 seconds before sending more messages.

Link copied to clipboard
fun toMap(): List<Map<String, Any?>>