Libsoftphone/cz.acrobits.libsoftphone.event/CallEvent

CallEvent

class CallEvent : Event

Call event.

Call event represents a single call.

A call can only be made with a single remote user. Conferences are made by joining multiple simultaneous calls.

Constructors

CallEvent

constructor()

Constructor.

constructor(@NonNull user: RemoteUser)

Constructor.

constructor(@Nullable accountId: String, @NonNull uri: String)

Constructor.

Types

Attributes

class Attributes : Event.Attributes

Attributes.

Result

class Result

Call result.

Type

@Retention(value = RetentionPolicy.SOURCE)

annotation class Type

Properties

transients

val transients: Json.Dict

Transient attributes.

Functions

addAttachment

open fun addAttachment(@NonNull attachment: EventAttachment)

addRemoteUser

open fun addRemoteUser(@NonNull user: RemoteUser)

Add remote user.

changeThread

open fun changeThread()

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

clearRemoteUsers

open fun clearRemoteUsers()

Clear all remote users.

open fun close()

Close the native pointer.

abstract fun close()

copyAsNew

@NonNull

open fun copyAsNew(): Event

Create a copy of the event as if it is newly created.

deleteRemoteUser

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

Delete remote user.

equals

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

Check if the pointer is equal to another one.

getAccountHint

@NonNull

open fun getAccountHint(): String

Getting representation label of account that handling call event, could be used for display in call UI.

getAccountId

@Nullable

open fun getAccountId(): String

Get account ID.

getAccountName

@Nullable

open fun getAccountName(): String

Get account name.

getAttachment

@NonNull

open fun getAttachment(id: Long): EventAttachment

getAttachmentAt

@NonNull

open fun getAttachmentAt(@IntRange(from = 0) i: Int): EventAttachment

getAttachmentCount

@IntRange(from = 0)

open fun getAttachmentCount(): Int

getAttribute

@Nullable

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

Get attribute.

getCurrentState

@Nullable

open fun getCurrentState(): Call.State

getDate

@NonNull

open fun getDate(): Date

Alias for getTimestamp().toDate()

getDirection

open fun getDirection(): Int

Get event direction.

getDuration

@FloatRange(from = 0)

open fun getDuration(): Double

Get call duration.

getEventId

open fun getEventId(): Long

Get event ID.

getFileAttribute

@Nullable

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

Get file attribute.

getForwardedToParty

@Nullable

open fun getForwardedToParty(): StreamParty

getGroupId

@Nullable

open fun getGroupId(): GroupObjectId

getHoldStates

open fun getHoldStates(): Call.HoldStates

getObjectId

@NonNull

open fun getObjectId(): CallObjectId

getRecording

@Nullable

open fun getRecording(): File

Get call recording.

getRemoteUser

@Nullable

open fun getRemoteUser(): RemoteUser

@Nullable

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

Get remote user.

getRemoteUserCount

@IntRange(from = 0)

open fun getRemoteUserCount(): Int

Get remote user count.

getResult

open fun getResult(): Int

Get result.

getSender

@Nullable

open fun getSender(): String

Get event sender.

getStorageStatus

open fun getStorageStatus(): Int

Get storage status of the event.

getStream

@Nullable

open fun getStream(): EventStream

Get stream.

getStreamKey

@Nullable

open fun getStreamKey(): String

Get stream key.

getTimeEstablished

@Nullable

open fun getTimeEstablished(): Timestamp

Get time when the call was established.

getTimestamp

@NonNull

open fun getTimestamp(): Timestamp

Get event timestamp.

getTransferredToParty

@Nullable

open fun getTransferredToParty(): StreamParty

getType

open fun getType(): Int

Check the call type.

hasAttachment

open fun hasAttachment(id: Long): Boolean

hasAttribute

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

Check whether event has attribute.

hashCode

open fun hashCode(): Int

Get hash code.

hasIncomingVideo

open fun hasIncomingVideo(): Boolean

hasOutgoingVideo

open fun hasOutgoingVideo(): Boolean

hasRecording

open fun hasRecording(): Boolean

Check whether the call has a recording.

hasRecordingProtected

open fun hasRecordingProtected(): Boolean

Check whether the call has a protected recording.

hasVideo

open fun hasVideo(): Boolean

isBeingRemoved

open fun isBeingRemoved(): Boolean

Check if the event is being removed.

isClosed

open fun isClosed(): Boolean

Check if the native pointer is closed.

isDirty

open fun isDirty(): Boolean

Check if the event is modified in memory cache.

isMutable

open fun isMutable(): Boolean

Check if the native pointer is mutable.

isNew

open fun isNew(): Boolean

Check if the event is new.

isRemoved

open fun isRemoved(): Boolean

Check if the event is removed.

isSameAs

open fun isSameAs(callEvent: CallEvent): Boolean

Check if the calls are same

isSamePointer

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

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

isStored

open fun isStored(): Boolean

Check if the event is stored in persistent storage.

removeAttachment

open fun removeAttachment(@NonNull id: Long)

removeAttachmentAt

open fun removeAttachmentAt(@IntRange(from = 0) i: Int)

removeAttribute

open fun removeAttribute(@NonNull name: String)

Remove attribute.

removeRecording

open fun removeRecording()

Remove call recording.

save

open fun save()

Save the event to the persistent storage.

saveAll

open fun saveAll()

Save all dirty events.

setAccount

open fun setAccount(@Nullable accountId: String)

Set account ID and name.

setAttribute

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

Set attribute.

setDirection

open fun setDirection(direction: Int)

Set event direction.

setDuration

open fun setDuration(@FloatRange(from = 0) duration: Double)

Set call duration.

setRecordingProtected

open fun setRecordingProtected(recordingProtected: Boolean)

setResult

open fun setResult(result: Int)

Set result.

setSender

open fun setSender(@Nullable sender: String)

Set event sender.

setStream

open fun setStream(@NonNull stream: EventStream)

Set stream.

setTimeEstablished

open fun setTimeEstablished(@Nullable time: Timestamp)

Set time when the call was established.

setTimestamp

open fun setTimestamp(@NonNull timestamp: Timestamp)

Set event timestamp.

setVideoEnabled

open fun setVideoEnabled(incoming: Boolean, outgoing: Boolean)

Set whether video is/was enabled.

toString

open fun toString(): String

Report string describing this pointer.

updateRecordingFilePath

open fun updateRecordingFilePath(filePath: String)

Update file path of recording file that stored in it's attribute.

wasForwarded

open fun wasForwarded(): Boolean

wasTransferred

open fun wasTransferred(): Boolean