Struct PhoneNumber

pub struct PhoneNumber { /* private fields */ }

Implementations

impl PhoneNumber

pub fn get(&self) -> Result<Option<String>>

Query for a previously verified phone number.

Requires network: no

pub fn register(&self, phone_number: String) -> Result<()>

Start the verification process for a new phone number. This will trigger an SMS containing an OTP to be sent to the provided phone_number. To conclude the verification process, the method PhoneNumber::verify should be called next.

Parameters:

• phone_number - the phone number to be registered. Needs to be checked for validity using PhoneNumber::parse_to_lightning_address.

Requires network: yes

pub fn verify(&self, phone_number: String, otp: String) -> Result<()>

Finish the verification process for a new phone number.

Parameters:

• phone_number - the phone number to be verified.
• otp - the OTP code sent as an SMS to the phone number.

Requires network: yes

pub fn parse_prefix( &self, phone_number_prefix: String, ) -> Result<(), ParsePhoneNumberPrefixError>

Parse a phone number prefix, check against the list of allowed countries (set in LightningNodeConfig::phone_number_allowed_countries_iso_3166_1_alpha_2). The parser is not strict, it parses some invalid prefixes as valid.

Requires network: no

pub fn parse_to_lightning_address( &self, phone_number: String, ) -> Result<String, ParsePhoneNumberError>

Parse a phone number, check against the list of allowed countries (set in LightningNodeConfig::phone_number_allowed_countries_iso_3166_1_alpha_2).

Returns a possible lightning address, which can be checked for existence with Util::decode_data.

Requires network: no