STREAMWIDE SDK Android 3.12.1/com.streamwide.smartms.lib.core.api.account.settings/STWAccountSettings

STWAccountSettings

This class represent all settings related to the account.

Functions

open fun deleteUserPicture(@NonNull context: Context, @Nullable callback: STWOperationCallback<STWAccountSettingsError>)

Call this method to delete the user profile picture

dispatchAccountInfoChanged

open fun dispatchAccountInfoChanged()

exportSettings

open fun exportSettings(@NonNull context: Context, @Nullable callback: STWExportSettingsCallback)

Method to export settings in order to share them with other contacts.

getAdminEmail

@Nullable

open fun getAdminEmail(): String

The email of the administrator to be contacted in case of issues (can be an empty string)

getAdminName

@Nullable

open fun getAdminName(): String

The name of the administrator to be contacted in case of issues (can be an empty string)

getApplicationLink

@Nullable

open fun getApplicationLink(@NonNull context: Context): String

Calle this method to retrieve the application link

getAttachmentSize

open fun getAttachmentSize(): Int

The total size in bytes of message attachments.

getCompanyId

@Nullable

open fun getCompanyId(@NonNull context: Context): String

Call this method to get the CompanyID

getFillPercentage

open fun getFillPercentage(): Int

The used storage in percentage.

getInstance

@NonNull

open fun getInstance(): STWAccountSettings

Account settings instance.

getMaxPictureSize

open fun getMaxPictureSize(@NonNull context: Context): Int

The maximum size of subscriber picture in kilo bytes who can be uploaded by user.

getMaxSizeForQuota

open fun getMaxSizeForQuota(): Int

The maximum allowed storage in bytes.

getOrganizationLabel

@Nullable

open fun getOrganizationLabel(@NonNull context: Context): String

getProcessesSize

open fun getProcessesSize(): Int

The total size in bytes of processes.

getServerName

@Nullable

open fun getServerName(@NonNull context: Context): String

Call this method to get the human friendly name of the SIP server.

getThresholdsAlertValue

open fun getThresholdsAlertValue(): Int

The percentage after which the alert notifications must be displayed to the user

getThresholdsWaringValue

open fun getThresholdsWaringValue(): Int

The percentage after which the warning notifications must be displayed to the user

getUsedSizeForQuota

open fun getUsedSizeForQuota(): Int

The used storage in bytes.

getUserAliasStatus

open fun getUserAliasStatus(@NonNull context: Context): Long

Call this method to get the status of alias

getUserAvailability

open fun getUserAvailability(@NonNull context: Context): Long

Call this method to retrieve the User Availability status

getUserCustomAlias

@Nullable

open fun getUserCustomAlias(@NonNull context: Context): String

getUserCustomStatus

@Nullable

open fun getUserCustomStatus(@NonNull context: Context): String

getUserDisplayName

@Nullable

open fun getUserDisplayName(@NonNull context: Context): String

Get get display name of the current user

getUserPhone

@Nullable

open fun getUserPhone(@NonNull context: Context): PhoneItem

Get the PhoneItem corresponding to the current user account

importSettings

open fun importSettings( @NonNull context: Context, @NonNull attachmentId: String, @Nullable callback: ImportSettingsCallBack)

@Deprecated

~~open~~ ~~fun~~ ~~importSettings~~( @NonNull context: Context, @NonNull path: String, @Nullable callback: STWImportSettingsCallback)

Method to import and apply settings received from other contacts.

isAliasModificationAllowed

open fun isAliasModificationAllowed(@NonNull context: Context): Boolean

Call this method to check if the modification of alias from client is allowed or not

isCloudStorageEnabled

open fun isCloudStorageEnabled(): Boolean

Call this method to check if the CloudStorage is enabled.

isDisplayDisconnectedUsersAllowed

open fun isDisplayDisconnectedUsersAllowed(@NonNull context: Context): Boolean

Call this method to check if display diconnected users when not reachable is allowed or not

isMessageAttachmentsCountedInStorage

open fun isMessageAttachmentsCountedInStorage(): Boolean

Whether the attachments are counted in the storage quota or not

isOperationalStatusAllowed

open fun isOperationalStatusAllowed(@NonNull context: Context): Boolean

Method to check if the OperationalStatus feature is enabled ot not

isProcessesCountedInStorage

open fun isProcessesCountedInStorage(): Boolean

Whether the processes are counted in the storage quota

isProfileModificationsFromClientAllowed

open fun isProfileModificationsFromClientAllowed(@NonNull context: Context): Boolean

Call this method to check whether the user can modified his profile status/picture or not

isUserAliasAllowed

open fun isUserAliasAllowed(@NonNull context: Context): Boolean

Call this method to check if Alias feature is allowed or not

isUserAvailabilityAllowed

open fun isUserAvailabilityAllowed(@NonNull context: Context): Boolean

Whether the subscriber user availability feature is enabled in backend or not

loadCompanyLogo

open fun loadCompanyLogo(@NonNull imageView: ImageView, @Nullable callback: STWOperationCallback<STWAccountSettingsError>)

Call this method to retrieve the current company logo

loadUserPicture

open fun loadUserPicture( @NonNull context: Context, @NonNull lifecycle: Lifecycle, @NonNull imageView: ImageView, @Nullable defaultContactIconResources: DefaultContactIconResources)

Try to load asynchronously the user picture in the imageView.

registerAccountChanged

open fun registerAccountChanged(@NonNull listener: STWAccountChanged)

registerCompanyInformationChanged

open fun registerCompanyInformationChanged(@NonNull listener: STWCompanyInformationChanged)

registerForDisconnectedUserFeatureChanged

open fun registerForDisconnectedUserFeatureChanged(@NonNull disconnectedUserFeatureChangedListener: STWDisconnectedUserFeatureChangedListener)

Call this method to register for events related to connected user feature

registerToAliasEvents

open fun registerToAliasEvents(@NonNull aliasCallback: STWUserCustomAliasCallback)

Call this method to register for events related to user alias feature

registerToAllowUserAvailabilityEvents

@Deprecated

~~open~~ ~~fun~~ ~~registerToAllowUserAvailabilityEvents~~(@NonNull allowUserAvailabilityCallback: STWAllowUserAvailabilityListener)

Call this method to register for events related to the user availability allowed or not.

registerToCloudStorageEvents

open fun registerToCloudStorageEvents(@NonNull cloudStorageCallback: STWCloudStorageCallback)

Listen to the cloud storage events

registerToDisplayNameOrderEvents

open fun registerToDisplayNameOrderEvents(@NonNull displayNameOrderCallback: STWDisplayNameOrderListener)

Listen to the display name order events

registerToOperationalStatusEvents

open fun registerToOperationalStatusEvents(@NonNull operationStatusCallback: STWOperationStatusListener)

Listen to the operational status events

registerToRoleIconEvents

open fun registerToRoleIconEvents(@NonNull roleIconCallback: STWRoleIconListener)

Listen to the role icon events

registerToServerNameChanges

open fun registerToServerNameChanges(@NonNull serverNameCallback: STWServerNameCallback)

Listen to the server name changes when the client switches between servers

registerToUserAvailability

open fun registerToUserAvailability(@NonNull listener: STWUserAvailabilityListener)

Call this method to register to the changing of the User Availability status.

registerToUserCustomStatus

open fun registerToUserCustomStatus(@NonNull listener: STWUserCustomStatusCallback)

Call this method to register to the changing of the User custom status.

requestForCloudStorageQuotaStatus

open fun requestForCloudStorageQuotaStatus(@NonNull context: Context)

Call this method to ask for the cloud quota storage values from the backend.

resetSettings

open fun resetSettings(@NonNull context: Context, @NonNull operationCallback: STWOperationCallback<STWAccountSettingsError>)

Call this method to reset all settings related to the account.

unregisterAccountChanged

open fun unregisterAccountChanged(@NonNull listener: STWAccountChanged)

Unregister a previously registered account information listener

unregisterCompanyInformationChanged

open fun unregisterCompanyInformationChanged(@NonNull listener: STWCompanyInformationChanged)

Unregister a previously registered company information listener

unregisterForDisconnectedUserFeatureChanged

open fun unregisterForDisconnectedUserFeatureChanged(@NonNull disconnectedUserFeatureChangedListener: STWDisconnectedUserFeatureChangedListener)

Call this method to unregister from events related to connected user feature

unregisterFromAliasEvents

open fun unregisterFromAliasEvents(@NonNull aliasCallback: STWUserCustomAliasCallback)

Call this method to unregister from events related to user alias feature

unregisterFromAllowUserAvailabilityEvents

open fun unregisterFromAllowUserAvailabilityEvents(@NonNull allowUserAvailabilityCallback: STWAllowUserAvailabilityListener)

Call this method to register for events related to the user availability allowed or not.

unregisterFromDisplayNameOrderEvents

open fun unregisterFromDisplayNameOrderEvents(@NonNull displayNameOrderCallback: STWDisplayNameOrderListener)

Stop listening to the display name order events

unregisterFromOperationalStatusEvents

open fun unregisterFromOperationalStatusEvents(@NonNull operationStatusCallback: STWOperationStatusListener)

Stop listening to the operational status events

unregisterFromRoleIconEvents

open fun unregisterFromRoleIconEvents(@NonNull roleIconCallback: STWRoleIconListener)

Stop listening to the role icon events

unregisterServerNameChanges

open fun unregisterServerNameChanges(@NonNull serverNameCallback: STWServerNameCallback)

Stop listening to the server name changes when the client switches between servers

unregisterToCloudStorageEvents

open fun unregisterToCloudStorageEvents(@NonNull cloudStorageCallback: STWCloudStorageCallback)

Stop listening to the cloud storage events

unregisterToUserAvailability

open fun unregisterToUserAvailability(@NonNull listener: STWUserAvailabilityListener)

Call this method to unregister from the changign of the User Availability status.

unregisterToUserCustomStatus

open fun unregisterToUserCustomStatus(@NonNull listener: STWUserCustomStatusCallback)

Call this method to unregister from the changing of the User custom status.

updateDisplayNameOrder

open fun updateDisplayNameOrder( @NonNull context: Context, @NonNull displayNameOrderValue: String, @Nullable callback: STWOperationCallback<STWAccountSettingsError>)

Call this method to change the display name order

updateUserAvailability

open fun updateUserAvailability( @NonNull context: Context, userAvailabilityValue: Int, @Nullable callback: STWOperationCallback<STWAccountSettingsError>)

Call this method to change the user availability

updateUserCustomAlias

open fun updateUserCustomAlias( @NonNull context: Context, @NonNull newCustomAlias: String, @Nullable callBack: STWOperationCallback<STWAccountSettingsError>)

Call this method to update the user custom alias

updateUserCustomStatus

open fun updateUserCustomStatus( @NonNull context: Context, @NonNull newCustomStatus: String, @Nullable callBack: STWOperationCallback<STWAccountSettingsError>)

Call this method to update the user custom status

updateUserOperationalStatus

open fun updateUserOperationalStatus( @NonNull context: Context, operationalStatusId: Int, @Nullable callBack: STWOperationCallback<STWAccountSettingsError>)

Update and synchronize user operational status

uploadUserPicture

open fun uploadUserPicture( @NonNull context: Context, @NonNull file: File, @Nullable callback: STWOperationCallback<STWAccountSettingsError>)

Call this method to update the user profile picture