class · iOS 18.0+ · SDK 27.1
class LiveCallerIDLookupManagerThe LiveCallerIDLookupManager gives the abilty of the App to know the state of the extension as well as modify that state.
openSettings(): Promise<void>func openSettings() async throwsWhen called, this will take the user to the setting page that contains the Live Caller ID Lookup and CallDirectory apps. This can be used as a shortcut for the user from the app to the settings to enable and prioritize these apps. - throws: When the system cannot open the settings, an error is thrown with information about why.
refreshPIRParameters(identifier: string): Promise<void>func refreshPIRParameters(forExtensionWithIdentifier identifier: String) async throwsAsks the system to refetch Private Information Retrieval (PIR) parameters from the server. PIR parameters change when server side database has a significant change. With usual dataset updates, some phone numbers are added and some are removed. When the database is preprocessed using the same parameters as the previous iteration then this does not need to be called. This needs to be called when PIR parameters change. Things that require PIR parameter update: * change of shard count * change of encryption parameters * change of per shard cuckoo hash table size (note: per shard entry count can change, while the cuckoo hash table stays fixed size) * change of cuckoo hashing parameters - parameter forExtensionWithIdentifier: The identifier of the extension - throws: When the system cannot refresh the PIR parameters, an error is thrown with information about why.
refreshExtensionContext(identifier: string): Promise<void>func refreshExtensionContext(forExtensionWithIdentifier identifier: String) async throwsAsks the system to refresh the Extension Context. Over the lifetime of the application, the URLs and tokens associated with the extension may need to change from time to time. For example, the URLs might need to change when a customer changes regions. The tokens may need to change when a user opts into or out of some functionality. - parameter forExtensionWithIdentifier: The identifier of the extension - throws: When the system cannot refresh the PIR parameters, an error is thrown with information about why.
reset(identifier: string): Promise<void>func reset(forExtensionWithIdentifier identifier: String) async throwsResets the cache associated with the extension. This may be useful if the 3rd party has updated their data and things that were possibly cached for long periods have changed. This will force the phone to go to the 3rd party service to fetch the data as necessary. - parameter forExtensionWithIdentifier: The identifier of the extension - throws: When the system cannot reset the cache, an error is thrown with information about why.
static get shared(): LiveCallerIDLookupManagerstatic let shared: LiveCallerIDLookupManagerReturns the shared live caller ID lookup manager instance for the app.
status(identifier: string): CallLookupExtensionStatusfunc status(forExtensionWithIdentifier identifier: String) -> CallLookupExtensionStatusQueries the system to see if the extension is enabled. This can be used by the app to determine if the app's extension is enabled. If the extension is not enabled the app can call openSettings to take the user to the screen to enable the extension. - parameter forExtensionWithIdentifier: The identifier of the extension
No declarations were skipped in this snapshot.