Inherits from NSObject
Declared in Bit6Address.h

Overview

Bit6Address is used to describe an user identity for calling and messaging.

Properties

isGroup

indicates if the sender refers to a group.

@property (nonatomic, readonly) BOOL isGroup

Declared In

Bit6Address.h

scheme

returns the sender’s scheme.

@property (nonatomic, readonly) Bit6AddressScheme scheme

Declared In

Bit6Address.h

supportsOffNetCommunications

indicates whether the sender supports OFFNET communications.

@property (nonatomic, readonly) BOOL supportsOffNetCommunications

Declared In

Bit6Address.h

uri

returns the URI representation of the sender.

@property (nonatomic, readonly, strong) NSString *uri

Declared In

Bit6Address.h

value

returns the sender’s value.

@property (nonatomic, readonly, strong) NSString *value

Declared In

Bit6Address.h

Class Methods

addressWithEmail:

Initializes a Bit6Address object using an email. The resulting object URI will become mailto:email .

+ (nullable instancetype)addressWithEmail:(NSString *)email

Parameters

email

value portion of the email URI.

Return Value

a Bit6Address object if succesful or nil if failed.

Declared In

Bit6Address.h

addressWithFacebookId:

Initializes a Bit6Address object using a Facebook identifier. The resulting object URI will become fb:facebookId .

+ (nullable instancetype)addressWithFacebookId:(NSString *)facebookId

Parameters

facebookId

identifier for a facebook user.

Return Value

a Bit6Address object if succesful or nil if failed.

Declared In

Bit6Address.h

addressWithPhone:

Initializes a Bit6Address object using an email. The resulting object URI will become tel:phone .

+ (nullable instancetype)addressWithPhone:(NSString *)phone

Parameters

phone

a valid phone number. Phone numbers must be in E164 format, prefixed with +. So a US (country code 1) number (555) 123-1234 must be presented as +15551231234.

Return Value

a Bit6Address object if succesful or nil if failed.

Declared In

Bit6Address.h

addressWithScheme:value:

Initializes a Bit6Address object using a scheme and a value. The resulting object URI will become scheme:value .

+ (nullable instancetype)addressWithScheme:(Bit6AddressScheme)scheme value:(NSString *)value

Parameters

scheme

scheme portion of the URI, for example “usr”, “tel”, “fb”, etc

value

value portion of the URI.

Return Value

a Bit6Address object if succesful or nil if failed.

Declared In

Bit6Address.h

addressWithURI:

Initializes a Bit6Address object

+ (nullable instancetype)addressWithURI:(NSString *)uri

Parameters

uri

URI string to identify the address. An URI address is a two part string composed by a scheme and a value, separated by a colon. Examples usr:calitb, mailto:bit6@bit6.com .

Return Value

a Bit6Address object if succesful or nil if failed.

Declared In

Bit6Address.h

addressWithUsername:

Initializes a Bit6Address object using an username. The resulting object URI will become usr:username .

+ (nullable instancetype)addressWithUsername:(NSString *)username

Parameters

username

value portion of the username URI.

Return Value

a Bit6Address object if succesful or nil if failed.

Declared In

Bit6Address.h

Instance Methods

hasScheme:

Returns a Boolean value that indicates whether a given scheme matches the sender’s scheme.

- (BOOL)hasScheme:(Bit6AddressScheme)aString

Parameters

aString

A string.

Return Value

YES if aString matches the URI’s sender, otherwise NO.

Declared In

Bit6Address.h

init

Unavailable init.

- (instancetype)init

Return Value

a new instance of the class.

Declared In

Bit6Address.h