firebase::invites::Listener

This is an abstract class.

#include <invites.h>

Base class used to receive Invites and Dynamic Links.

Summary

Constructors and Destructors

~Listener()

Public functions

OnErrorReceived(int error_code, const char *error_message)=0
virtual void
Called when an error occurs trying to fetch the invitation information.
OnInviteNotReceived()=0
virtual void
Called when there was no invitation or dynamic link tied to opening the app.
OnInviteReceived(const char *invitation_id, const char *dynamic_link, bool is_strong_match)=0
virtual void
Called when an invitation is received.

Public functions

OnErrorReceived

virtual void OnErrorReceived(
  int error_code,
  const char *error_message
)=0

Called when an error occurs trying to fetch the invitation information.

Details
Parameters
error_code
The code associated with the error.
error_message
A description of the error that occurred.

OnInviteNotReceived

virtual void OnInviteNotReceived()=0

Called when there was no invitation or dynamic link tied to opening the app.

OnInviteReceived

virtual void OnInviteReceived(
  const char *invitation_id,
  const char *dynamic_link,
  bool is_strong_match
)=0

Called when an invitation is received.

This invitation ID will match the invitation ID on the sender side, so you can use analytics to determine that the invitation was accepted, and even save it for future analytical use.

If Firebase indicates a weak match for a dynamic link, it means that the match between the dynamic link and the receiving device may not be perfect. In this case your app should reveal no personal information from the dynamic link.

Details
Parameters
invitation_id
The Invitation ID. Will be null if there was just a dynamic link, without an invitation.
dynamic_link
The Dynamic Link URL. Will be empty if there was just an AppInvite and not a Dynamic Link.
is_strong_match
Whether the Dynamic Link is a "strong match" or a "weak match" as defined by the Invites library.

~Listener

virtual  ~Listener()

Send feedback about...

Need help? Visit our support page.