unreal.MagicLeapConnectionsFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Magic Leap Connections Function Library

C++ Source:

  • Plugin: MagicLeapConnections

  • Module: MagicLeapConnections

  • File: MagicLeapConnectionsFunctionLibrary.h

classmethod cancel_invite(invite_request_handle) → bool

Attempts to cancel a previously requested invite sending process. If invite dialog has not yet been completed by the user, this request will dismiss the dialog and cancel the invite sending process. Otherwise this operation will return an error.

Parameters

invite_request_handle (Guid) – The handle to the invite to be cancelled.

Returns

True if the invite was cancelled, false otherwise.

Return type

bool

classmethod disable_invites() → None

Disables the sending and receiving of invites.

classmethod enable_invites_async(invite_received_delegate) → None

Enables the sending and receiving of invites.

Parameters

invite_received_delegate (MagicLeapInviteReceivedDelegate) – User delegate to be notified when an invite is received.

classmethod is_invites_enabled() → bool

Indicates the current status of the invite send/receive servers.

Returns

True if sending and receiving invites are enabled, false otherwise.

Return type

bool

classmethod send_invite_async(args, invite_sent_delegate) → Guid or None

Submits a request to start the invite sending process. Request an invite to be sent for other connections to join a multi-user experience. This call will trigger a connections invite dialog requesting the user to select up to the specified number of online users to be invited. The system will then initiate a push notification to other online devices, start a copy of the application requesting the invite and deliver the given payload. If the requesting application is not installed on the receiving device, the system will prompt the user to install via Magic Leap World app.

Parameters
Returns

True if the invite is successfully created, false otherwise.

out_invite_handle (Guid): A valid FGuid to the invite request if the function call succeeds.

Return type

Guid or None