| Method | Description | |
|---|---|---|
| addPhoneNumber ( string $phoneNumber ) : boolean | add phone number | |
| areSMSAPICredentialProvided ( ) : boolean | determine if SMS API credential are available for the current user | |
| deleteSMSAPICredential ( ) : boolean | delete the SMS API credential | |
| getActivatedPhoneNumbers ( ) : array | get activated phone number list | |
| getCreditLeft ( ) : string | get remaining credit | |
| getDelegatedManagement ( ) : boolean | Determine if normal users can manage their own SMS API credential | |
| getPhoneNumbers ( ) : array | get phone number list | |
| getSMSProvider ( ) : string | return the SMS API Provider for the current user | |
| removePhoneNumber ( string $phoneNumber ) : boolean | remove phone number | |
| sanitizePhoneNumber ( string $phoneNumber ) : string | sanitize phone number | |
| sendSMS ( string $content, string $phoneNumber, string $from ) : boolean | send a SMS | |
| setDelegatedManagement ( boolean $delegatedManagement ) | Specify if normal users can manage their own SMS API credential | |
| setSMSAPICredential ( string $provider, string $apiKey ) : boolean | set the SMS API credential | |
| validatePhoneNumber ( string $phoneNumber, string $verificationCode ) : boolean | validate phone number |
| Method | Description | |
|---|---|---|
| checkCredentialManagementRights ( ) | ||
| getCredentialManagerLogin ( ) | ||
| getCredentialManagerSettings ( ) | ||
| getCurrentUserSettings ( ) | ||
| getSMSAPICredential ( ) | ||
| getUserSettings ( $user ) | ||
| increaseCount ( $option, $phoneNumber ) | ||
| isActivated ( $verificationCode ) | ||
| retrievePhoneNumbers ( ) | ||
| savePhoneNumbers ( $phoneNumbers ) | ||
| setCredentialManagerSettings ( $settings ) | ||
| setCurrentUserSettings ( $settings ) | ||
| setUserSettings ( $user, $settings ) |
| public addPhoneNumber ( string $phoneNumber ) : boolean | ||
| $phoneNumber | string | |
| return | boolean | true |
| public areSMSAPICredentialProvided ( ) : boolean | ||
| return | boolean | true if SMS API credential are available for the current user |
| public deleteSMSAPICredential ( ) : boolean | ||
| return | boolean | true |
| public getActivatedPhoneNumbers ( ) : array | ||
| return | array | $phoneNumber |
| public getCreditLeft ( ) : string | ||
| return | string | remaining credit |
| public getDelegatedManagement ( ) : boolean | ||
| return | boolean | false if SMS API credential only manageable by super admin, true otherwise |
| public getPhoneNumbers ( ) : array | ||
| return | array | $phoneNumber => $isValidated |
| public getSMSProvider ( ) : string | ||
| return | string | SMS API Provider |
| public removePhoneNumber ( string $phoneNumber ) : boolean | ||
| $phoneNumber | string | |
| return | boolean | true |
| public static sanitizePhoneNumber ( string $phoneNumber ) : string | ||
| $phoneNumber | string | |
| return | string | sanitized phone number |
| public setDelegatedManagement ( boolean $delegatedManagement ) | ||
| $delegatedManagement | boolean | false if SMS API credential only manageable by super admin, true otherwise |
