Class AddressBook

The AddressBook class provides cross-platform interface to access the contact information.

Inheritance

System.Object

AddressBook

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: VoxelBusters.EssentialKit

Assembly: cs.temp.dll.dll

Syntax

public static class AddressBook

Properties

UnitySettings

Declaration

public static AddressBookUnitySettings UnitySettings { get; }

Property Value

Type	Description
AddressBookUnitySettings

Methods

GetContactsAccessStatus()

Returns the current permission status provided to access the contact data.

Declaration

public static AddressBookContactsAccessStatus GetContactsAccessStatus()

Returns

Type	Description
AddressBookContactsAccessStatus	The current permission status to access the contact data.

IsAvailable()

Declaration

public static bool IsAvailable()

Returns

Type	Description
System.Boolean

ReadContacts(EventCallback<AddressBookReadContactsResult>)

Declaration

public static void ReadContacts(EventCallback<AddressBookReadContactsResult> callback)

Parameters

Type	Name	Description
EventCallback<AddressBookReadContactsResult>	callback

ReadContactsWithUserPermission(EventCallback<AddressBookReadContactsResult>)

Retrieves all the contact information saved in address book database. This action checks user permission level and requests for permission if not provided before.

Declaration

public static void ReadContactsWithUserPermission(EventCallback<AddressBookReadContactsResult> callback)

Parameters

Type	Name	Description
EventCallback<AddressBookReadContactsResult>	callback	The callback that will be executed after the operation is completed.

Examples

The following code example demonstrates how to read contacts information.

using UnityEngine;
using System.Collections;
using VoxelBusters.EssentialKit;

public class ExampleClass : MonoBehaviour 
{       
    public void Start()
    {
        // initiate request to read contacts data
        AddressBook.ReadContactsWithUserPermission(OnReadContactsFinished); 
    }

    // callback method executed when read request is finished
    private void OnReadContactsFinished(AddressBookReadContactsResult data, NativeResultException exception)
    {
        if (null == exception)
        {
            IAddressBookContact[]   contacts    = data.Contacts;
            foreach (IAddressBookContact entry in contacts)
            {
                Debug.Log(entry);
            }
        }
        else
        {
            // user didn't provide necessary permission
        }
    }
}

RequestContactsAccess(Boolean, EventCallback<AddressBookRequestContactsAccessResult>)

Requests permission to access contact data.

Declaration

public static void RequestContactsAccess(bool showPrepermissionDialog = true, EventCallback<AddressBookRequestContactsAccessResult> callback = null)

Parameters

Type	Name	Description
System.Boolean	showPrepermissionDialog	Indicates whether pre-confirmation is required, before prompting system permission dialog.
EventCallback<AddressBookRequestContactsAccessResult>	callback	Callback method that will be invoked after operation is completed.