commonMain.com.pubnub.api.models.consumer.objects.membership.PNChannelMembership.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pubnub-kotlin-api-jvm Show documentation

PubNub is a cross-platform client-to-client (1:1 and 1:many) push service in the cloud, capable of broadcasting real-time messages to millions of web and mobile clients simultaneously, in less than a quarter second!

The newest version!

package com.pubnub.api.models.consumer.objects.membership

import com.pubnub.api.models.consumer.objects.channel.PNChannelMetadata
import com.pubnub.api.models.consumer.pubsub.objects.PNSetMembershipEvent
import com.pubnub.api.utils.PatchValue
import com.pubnub.kmp.CustomObject

data class PNChannelMembership(
    val channel: PNChannelMetadata,
    val custom: PatchValue?>? = null,
    val updated: String,
    val eTag: String,
    val status: PatchValue? = null,
) {
    data class Partial(
        val channelId: String,
        override val custom: CustomObject? = null,
        override val status: String? = null,
    ) : ChannelMembershipInput {
        override val channel: String = channelId
    }

    // let's not make this public for now, but keep the implementation around in case it's needed
    private operator fun plus(update: PNChannelMembership): PNChannelMembership {
        return PNChannelMembership(
            channel + update.channel,
            update.custom ?: custom,
            update.updated,
            update.eTag,
            update.status ?: status
        )
    }

    /**
     * Merge information from this `PNChannelMembership` with new data from `update`, returning a new `PNChannelMembership` instance.
     */
    operator fun plus(update: PNSetMembershipEvent): PNChannelMembership {
        return PNChannelMembership(
            channel,
            update.custom ?: custom,
            update.updated,
            update.eTag,
            update.status ?: status
        )
    }
}