unreal.MagicLeapContactsFunctionLibrary

class unreal.MagicLeapContactsFunctionLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Magic Leap Contacts Function Library

C++ Source:

  • Plugin: MagicLeapContacts

  • Module: MagicLeapContacts

  • File: MagicLeapContactsFunctionLibrary.h

classmethod add_contact_async(contact, result_delegate)Guid

Initiates the creation of a new contact.

Parameters
Returns

A unique identifier for this request.

Return type

Guid

classmethod delete_contact_async(contact, result_delegate)Guid

Initiates the deletion of an existing contact.

Parameters
Returns

A unique identifier for this request.

Return type

Guid

classmethod edit_contact_async(contact, result_delegate)Guid

Initiates the update of an existing contact.

Parameters
Returns

A unique identifier for this request.

Return type

Guid

classmethod request_contacts_async(result_delegate, max_num_results)Guid

Initiates the retrieval of the entire contacts list from the cloud.

Parameters
  • result_delegate (MagicLeapMultipleContactsResultDelegate) – The delegate to be notified once the contacts list has been retrieved from the cloud.

  • max_num_results (int32) – The maximum number of results to return.

Returns

A unique identifier for this request.

Return type

Guid

classmethod search_contacts_async(query, search_field, result_delegate)Guid

Initiates a search for contacts with a given query across specified fields.

Parameters
Returns

A unique identifier for this request.

Return type

Guid

classmethod select_contacts_async(result_delegate, max_num_results, search_field)Guid

Pops up a dialog allowing the user to manually select the contacts they wish to query.

Parameters
Returns

A unique identifier for this request.

Return type

Guid

classmethod set_log_delegate(log_delegate)bool

Sets the delegate by which the system can pass log messages back to the calling blueprint.

Parameters

log_delegate (MagicLeapContactsLogMessage) – The delegate by which the system will return log messages to the calling blueprint.

Returns

True if the call succeeds, false otherwise.

Return type

bool

classmethod shutdown()bool

Deinitialize all resources for this API.

Returns

Return type

bool

classmethod startup()bool

Initialize all necessary resources for using the Contacts API.

Returns

Return type

bool