Inherits from NSObject
Declared in BXU.h

Overview

BXU offers some generic functionality like setting the ContactDataSource to use through the framework, to show incoming message banners and deletion of cache pictures.

Class Methods

availableStreamsIn:

Convenient method to get the enabled streams in Bit6UI framework from a given streams param.

+ (Bit6CallStreams)availableStreamsIn:(Bit6CallStreams)streams

Parameters

streams

the list of streams we want to compare.

Return Value

the enabled streams in the given streams param.

Declared In

BXU.h

callMediaMode

The current call media mode.

+ (Bit6CallMediaMode)callMediaMode

Declared In

BXU.h

clearProfilePictureForAddress:

Deletes an identity profile picture from cache.

+ (BOOL)clearProfilePictureForAddress:(Bit6Address *)address

Parameters

address

identity of the profile picture to delete.

Return Value

YES if the file was deleted from cache.

Declared In

BXU.h

clearProfilePictures

Deletes the profile pictures from cache.

+ (NSUInteger)clearProfilePictures

Return Value

number of files deleted.

Declared In

BXU.h

contactSource

Gets the current BXUContactSource object.

+ (nullable id<BXUContactSource>)contactSource

Return Value

contact source object.

Declared In

BXU.h

displayImageURLForAddress:

Returns the image URL for an specified identity.

+ (nullable NSURL *)displayImageURLForAddress:(Bit6Address *)address

Parameters

address

identity to search for the image URL.

Return Value

image URL for the identity.

Declared In

BXU.h

displayNameForAddress:

Returns the display name for an specified identity. If no contact is provided for the identity in the +[BXU contactSource] then a default display name will be generated.

+ (NSString *)displayNameForAddress:(Bit6Address *)address

Parameters

address

identity to search for an display name.

Return Value

display name for the identity.

Declared In

BXU.h

enableAudioCalls

The current configuration for audio calls support.

+ (BOOL)enableAudioCalls

Return Value

YES if audio calls are enabled.

Declared In

BXU.h

enableCallsWithData

The current configuration for data transfers during a call.

+ (BOOL)enableCallsWithData

Return Value

YES if data transfer should be enabled in the calls.

Declared In

BXU.h

enableVideoCalls

The current configuration for video calls support.

+ (BOOL)enableVideoCalls

Return Value

YES if video calls are enabled.

Declared In

BXU.h

initialsForAddress:

Returns the name initials for an specified identity.

+ (NSString *)initialsForAddress:(Bit6Address *)address

Parameters

address

identity to search for the name initials.

Return Value

name initials for the identity.

Declared In

BXU.h

setCallMediaMode:

Indicates if the calls will go P2P or if the server should process the media.

+ (void)setCallMediaMode:(Bit6CallMediaMode)callMediaMode

Parameters

callMediaMode

P2P or MIX to process the calls media in the server.

Declared In

BXU.h

setContactSource:

Sets the current BXUContactSource object to use through the framework.

+ (void)setContactSource:(nullable id<BXUContactSource>)contactDataSource

Parameters

contactDataSource

contact source object to set.

Discussion

Note: After a logout this value will be set to nil automatically.

Declared In

BXU.h

setEnableAudioCalls:

Used to configure the support for audio streams in the calls.

+ (void)setEnableAudioCalls:(BOOL)enable

Parameters

enable

YES if audio streams should be available during the calls.

Declared In

BXU.h

setEnableCallsWithData:

Used to configure the support for data transfers in the calls.

+ (void)setEnableCallsWithData:(BOOL)enable

Parameters

enable

YES if data transfers should be available during the calls.

Declared In

BXU.h

setEnableVideoCalls:

Used to configure the support for video streams in the calls.

+ (void)setEnableVideoCalls:(BOOL)enable

Parameters

enable

YES if video streams should be available during the calls.

Declared In

BXU.h

showNotificationFrom:message:tappedHandler:

Shows a incoming message notification banner.

+ (void)showNotificationFrom:(Bit6Address *)from message:(NSString *)message tappedHandler:(nullable void ( ^ ) ( Bit6Address *_Nullable from ))tappedHandler

Parameters

from

identity to use as the sender of the message.

message

message to show in the banner

tappedHandler

handler to execute if the banner is tapped

Declared In

BXU.h

Instance Methods

init

Unavailable init

- (instancetype)init

Return Value

a new instance of the class.

Declared In

BXU.h