Libsoftphone/cz.acrobits.libsoftphone.event/EventStream

EventStream

class EventStream : Pointer

Event stream.

Types

Attributes

open class Attributes

Attributes.

Prefix

class Prefix

Prefixes for stream keys.

Properties

key

@NonNull

val key: String

Stream key.

transients

val transients: Json.Dict

Transient attributes.

Functions

addStreamParty

open fun addStreamParty(@NonNull party: StreamParty)

Add a stream party.

changeThread

open fun changeThread()

Change thread this pointer can be accessed from to the current one.

clearStreamParties

open fun clearStreamParties()

Clear stream parties.

open fun close()

Close the native pointer.

abstract fun close()

equals

open fun equals(@Nullable o: Any): Boolean

Check if the pointer is equal to another one.

generate

@NonNull

open fun generate(): EventStream

Create a new stream with generated name.

getAttribute

@Nullable

open fun getAttribute(@NonNull name: String): String

Get attribute.

getAvatarPath

open fun getAvatarPath(): File

Get avatar path from stream.

getExpandableAttribute

@Nullable

open fun getExpandableAttribute(@NonNull name: String): File

Get expandable attribute.

getLastEventTimestamp

@NonNull

open fun getLastEventTimestamp(): Timestamp

Get last event timestamp.

getLastSeenTimestamp

@NonNull

open fun getLastSeenTimestamp(): Timestamp

Get last seen timestamp.

getNamed

@Nullable

open fun getNamed(@NonNull name: String, update: Boolean): EventStream

Get a stream with specified name.

getSingle

@Nullable

open fun getSingle(@NonNull party: StreamParty, update: Boolean): EventStream

Get a stream with single party.

getStorageStatus

open fun getStorageStatus(): Int

Get storage status of the stream.

getStreamParties

@NonNull

open fun getStreamParties(): List<StreamParty>

Get all stream parties.

getStreamParty

@NonNull

open fun getStreamParty(@IntRange(from = 0) index: Int): StreamParty

Get stream party.

@Nullable

open fun getStreamParty(transportUri: String): StreamParty

Get stream party by transportUri.

getStreamPartyCount

@IntRange(from = 0)

open fun getStreamPartyCount(): Int

Get stream party count.

getUnreadCount

@IntRange(from = 0)

open fun getUnreadCount(): Int

Get stream unread count.

hasAttribute

open fun hasAttribute(@NonNull attribute: String): Boolean

Check whether stream has attribute.

hashCode

open fun hashCode(): Int

Get hash code.

isAttentionNeeded

open fun isAttentionNeeded(): Boolean

Check if stream needs attention.

isClosed

open fun isClosed(): Boolean

Check if the native pointer is closed.

isDirty

open fun isDirty(): Boolean

Check if the stream is modified in memory cache.

isGenerated

open fun isGenerated(): Boolean

Check if the stream is generated stream.

isGroupStream

open fun isGroupStream(): Boolean

Check if a group stream.

isMutable

open fun isMutable(): Boolean

Check if the native pointer is mutable.

isNamed

open fun isNamed(): Boolean

Check if the stream is named stream.

isRemoved

open fun isRemoved(): Boolean

Check if the stream is removed.

isSamePointer

open fun isSamePointer(@NonNull other: Pointer): Boolean

Check if the pointer is the same as in another pointer.

isSingle

open fun isSingle(): Boolean

Check if the stream is single-party stream.

isStored

open fun isStored(): Boolean

Check if the stream is stored in persistent storage.

load

@Nullable

open fun load(@NonNull streamKey: String): EventStream

Load a stream.

removeStreamParty

open fun removeStreamParty(@NonNull party: StreamParty)

open fun removeStreamParty(@IntRange(from = 0) index: Int)

open fun removeStreamParty(@NonNull genericUri: String)

Remove a stream party.

save

open fun save()

Save the stream to the persistent storage.

saveAll

open fun saveAll()

Save all dirty streams.

setAttentionFree

open fun setAttentionFree()

Set that stream no longer needs attention.

setAttribute

open fun setAttribute(@NonNull name: String, @Nullable value: String)

Set attribute.

setLastSeenNow

open fun setLastSeenNow()

Set last seen timestamp to actual time.

setLastSeenTimestamp

open fun setLastSeenTimestamp(@NonNull timestamp: Timestamp)

Set last seen timestamp.

toString

open fun toString(): String

Report string describing this pointer.

updateStreamParty

open fun updateStreamParty(@NonNull party: StreamParty)

Update a stream party.