AKFPhoneNumber - Documentation - Meta for Developers

AKFPhoneNumber

This class represents a phone number.

Conforms to:	`NSCopying, NSSecureCoding`
Superclass:	`NSObject`
Declared in:	`AKFPhoneNumber.h`

Properties

countryCode

The country code for the phone number.

@property (nonatomic,
    copy,
    readonly) NSString *countryCode;

Declared In: AKFPhoneNumber.h

phoneNumber

The remaining portion of the phone number after the country code.

@property (nonatomic,
    copy,
    readonly) NSString *phoneNumber;

Declared In: AKFPhoneNumber.h

Instance Methods

initWithCountryCode:phoneNumber:

This is the designated initializer.

Parameter	Description
`countryCode`	The country code for the phone number
`phoneNumber`	The remaining portion of the phone number

- (instancetype)

`initWithCountryCode:`	`(NSString *)countryCode`
`phoneNumber:`	`(NSString *)phoneNumber`
	`NS_DESIGNATED_INITIALIZER;`

Discussion:

While it is safe to provide any characters for the countryCode and phoneNumber, the values should only contain digits. All other characters will be stripped from this value when it is used.

Declared In: AKFPhoneNumber.h

isEqualToPhoneNumber:

Compares the receiver to another phone number

Parameter	Description
`phoneNumber`	The phone number to compare to

- (BOOL) isEqualToPhoneNumber:(AKFPhoneNumber *)phoneNumber;

Declared In: AKFPhoneNumber.h

stringRepresentation

Converts the receiver to an NSString.

- (NSString *) stringRepresentation;

Discussion:

All characters that are not digits will be stripped from the phone number and a + character will precede the country code value.

Declared In: AKFPhoneNumber.h