[ Web Proxy ]
URL:
Viewing: https://firebase.google.com/docs/reference/ios/firebaseinstanceid/api/reference/Type-Definitions [Back]  [Original]
FirebaseInstanceID Framework Reference Skip to main content
Firebase [Firebase]
Build Run Solutions Pricing Docs Support
Search:
Blog Go to console
Overview Fundamentals AI Build Run Reference Samples
Firebase [Firebase]
Send feedback

FirebaseInstanceID Framework Reference Stay organized with collections Save and categorize content based on your preferences.

Type Definitions

Firebase Instance ID is deprecated. Please use Firebase Installations instead.

The following type definitions are available globally.

  • @related FIRInstanceID

    The completion handler invoked when the InstanceID token returns. If the call fails we return the appropriate error code as described below.

    Declaration

    Objective-C

    typedef void (^FIRInstanceIDTokenHandler)(NSString *_Nullable,
                                          NSError *_Nullable)

    Parameters

    token

    The valid token as returned by InstanceID backend.
    error

    The error describing why generating a new token failed. See the error codes below for a more detailed description.

  • @related FIRInstanceID

    The completion handler invoked when the InstanceID deleteToken returns. If the call fails we return the appropriate error code as described below

    Declaration

    Objective-C

    typedef void (^FIRInstanceIDDeleteTokenHandler)(NSError *_Nonnull)

    Parameters

    error

    The error describing why deleting the token failed. See the error codes below for a more detailed description.

  • @related FIRInstanceID

    The completion handler invoked when the app identity is created. If the identity wasn’t created for some reason we return the appropriate error code.

    Declaration

    Objective-C

    typedef void (^FIRInstanceIDHandler)(NSString *_Nullable, NSError *_Nullable)

    Parameters

    identity

    A valid identity for the app instance, nil if there was an error while creating an identity.
    error

    The error if fetching the identity fails else nil.

  • @related FIRInstanceID

    The completion handler invoked when the app identity and all the tokens associated with it are deleted. Returns a valid error object in case of failure else nil.

    Declaration

    Objective-C

    typedef void (^FIRInstanceIDDeleteHandler)(NSError *_Nullable)

    Parameters

    error

    The error if deleting the identity and all the tokens associated with it fails else nil.

  • @related FIRInstanceID

    The completion handler invoked when the app identity and token are fetched. If the identity wasn’t created for some reason we return the appropriate error code.

    Declaration

    Objective-C

    typedef void (^FIRInstanceIDResultHandler)(FIRInstanceIDResult *_Nullable,
                                           NSError *_Nullable)

    Parameters

    result

    The result containing an identity for the app instance and a valid token, nil if there was an error while creating the result.
    error

    The error if fetching the identity or token fails else nil.
Send feedback

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2021-02-11 UTC.

Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2021-02-11 UTC."],[],[]]
Web Proxy Viewer  |  New URL  |  Original Page