Bit6Address Class Reference
Inherits from | NSObject |
Declared in | Bit6Address.h |
Tasks
Initializers
-
+ addressWithURI:
-
+ addressWithScheme:value:
-
+ addressWithUsername:
-
+ addressWithEmail:
-
+ addressWithPhone:
-
+ addressWithFacebookId:
Properties
-
displayName
property -
uri
property -
scheme
property -
value
property
Utilities
-
isGroup
property -
– hasScheme:
Properties
displayName
A display name for the sender.
@property (nullable, nonatomic, readonly) NSString *displayName
Declared In
Bit6Address.h
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 (nonnull, nonatomic, readonly) NSString *scheme
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:(nonnull NSString *)email
Parameters
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:(nonnull 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:(nonnull NSString *)phone
Parameters
- phone
a valid phone number. It must include the country code, for example +19543308410.
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:(nonnull NSString *)scheme value:(nonnull 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:(nonnull 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:(nonnull 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