firebase::invites

Enum describing the strength of a dynamic links match.

This version is local to invites; it mirrors the enum firebase::dynamic_links::LinkMatchStrength in dynamic_links.

Mark the invitation as "converted" in some app-specific way.

Once you have acted on the invite in some application-specific way, you can call this function to tell Firebase that a "conversion" has occurred and the invite has been acted on in some significant way.

You don't need to convert immediately when it received, since a "conversion" can happen far in the future from when the invite was initially received, e.g. if it corresponds to the user setting up an account, making a purchase, etc.

Just save the invitation ID when you initially receive it, and use it later when performing the conversion.

Usage:

auto convert_result =
    ::firebase::invites::ConvertInvitation(my_invitation_id);
// ... later on ...
if (convert_result.Status() == kFutureStatusComplete) {
  if (convert_result.Error() == 0) {
    // successfully marked the invitation as converted!
  }
}

Deprecated. Firebase Invites is deprecated. Please refer to https://firebase.google.com/docs/invites for details.

Get the (possibly still pending) results of the most recent ConvertInvitation call.

Fetch any pending invites.

Each pending invite will trigger a call to the appropriate function on the registered Listener class.

This function is implicitly called on initialization. On iOS this is called automatically when the app gains focus, but on Android this needs to be called manually.

Deprecated. Firebase Invites is deprecated. Please refer to https://firebase.google.com/docs/invites for details.

Initialize the Firebase Invites library.

You must call this in order to send and receive invites.

Deprecated. Firebase Invites is deprecated. Please refer to https://firebase.google.com/docs/invites for details.

Start displaying the invitation UI, which will ultimately result in sending zero or more invitations.

This will take the invitation settings from the given Invite object, and display a UI to the user where they can share a link to the app with their friends.

At a minimum, you will need to have set title_text and message_text or the invitation will not be sent.

Usage:

::firebase::invites::Invite invite;
// ... set fields on invite ...
auto send_result = ::firebase::invites::SendInvite(invite);
// ... later on ...
if (send_result.Status() == kFutureStatusComplete) {
  if (send_result.Error() == 0) {
    if (send_result.Result()->invitation_ids.length() > 0) {
      // Invitations were sent.
    }
    else {
      // User canceled.
    }
  }
}

Deprecated. Firebase Invites is deprecated. Please refer to https://firebase.google.com/docs/invites for details.

Get the results of the previous call to SendInvite.

This will stay available until you call SendInvite again.

Set the listener to handle receiving invitations.

Deprecated. Firebase Invites is deprecated. Please refer to https://firebase.google.com/docs/invites for details.

Terminate the Invites API.

Cleans up resources associated with the API.