com.pexip.sdk.conference.Message.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk-conference Show documentation

A set of tools to interact with conferences.

The newest version!

/*
 * Copyright 2023-2024 Pexip AS
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.pexip.sdk.conference

import com.pexip.sdk.infinity.ParticipantId
import kotlinx.datetime.Instant

/**
 * A message that can be received from [Messenger].
 *
 * @property at a timestamp in milliseconds
 * @property participantId a unique identifier of the sender
 * @property participantName a display name of the sender
 * @property type a payload's MIME type (e.g. "text/plain")
 * @property payload actual contents of this [Message]
 * @property direct true if this is a direct message, false otherwise
 */
public data class Message(
    val at: Instant,
    val participantId: ParticipantId,
    val participantName: String,
    val type: String,
    val payload: String,
    val direct: Boolean,
)