FirebaseFunctions Framework Reference

FIRFunctions

@interfaceFIRFunctions:NSObject

Functions is the client for Cloud Functions for a Firebase project.

  • Creates a Cloud Functions client using the default or returns a pre-existing instance if it already exists.

    returns:A shared Functions instance initialized with the defaultFirebaseApp.

    Declaration

    Objective-C

    +(FIRFunctions*_Nonnull)functions;

  • Creates a Cloud Functions client with the given app, or returns a pre-existinginstance if one already exists.\param app The app for the Firebase project.

    returns:A shared Functions instance initialized with the specifiedFirebaseApp.

    Declaration

    Objective-C

    +(FIRFunctions*_Nonnull)functionsForApp:(FIRApp*_Nonnull)app;

  • Creates a Cloud Functions client with the default app and given region.\param region The region for the HTTP trigger, such asus-central1.

    returns:A shared Functions instance initialized with the defaultFirebaseApp and a custom region.

    Declaration

    Objective-C

    +(FIRFunctions*_Nonnull)functionsForRegion:(NSString*_Nonnull)region;

  • Creates a Cloud Functions client with the given app and region, or returns a pre-existinginstance if one already exists.\param customDomain A custom domain for the HTTP trigger, such as "https //mydomain.com".

    returns:A shared Functions instance initialized with the defaultFirebaseApp and a custom HTTP trigger domain.

    Declaration

    Objective-C

    +(FIRFunctions*_Nonnull)functionsForCustomDomain:(NSString*_Nonnull)customDomain;

  • Creates a Cloud Functions client with the given app and region, or returns a pre-existinginstance if one already exists.\param app The app for the Firebase project.

    \param region The region for the HTTP trigger, such asus-central1.

    returns:An instance ofFunctions with a custom app and region.

    Declaration

    Objective-C

    +(FIRFunctions*_Nonnull)functionsForApp:(FIRApp*_Nonnull)appregion:(NSString*_Nonnull)region;

  • Creates a Cloud Functions client with the given app and region, or returns a pre-existinginstance if one already exists.\param app The app for the Firebase project.

    \param customDomain A custom domain for the HTTP trigger, such ashttps://mydomain.com.

    returns:An instance ofFunctions with a custom app and HTTP trigger domain.

    Declaration

    Objective-C

    +(FIRFunctions*_Nonnull)functionsForApp:(FIRApp*_Nonnull)appcustomDomain:(NSString*_Nonnull)customDomain;

  • Creates a reference to the Callable HTTPS trigger with the given name.\param name The name of the Callable HTTPS trigger.

    Declaration

    Objective-C

    -(FIRHTTPSCallable*_Nonnull)HTTPSCallableWithName:(NSString*_Nonnull)name;

  • Undocumented

    Declaration

    Objective-C

    -(FIRHTTPSCallable*_Nonnull)HTTPSCallableWithURL:(NSURL*_Nonnull)urlSWIFT_WARN_UNUSED_RESULT;

  • Changes this instance to point to a Cloud Functions emulator running locally.Seehttps://firebase.google.com/docs/functions/local-emulator\param host The host of the local emulator, such as "localhost".

    \param port The port of the local emulator, for example 5005.

    Declaration

    Objective-C

    -(void)useEmulatorWithHost:(NSString*_Nonnull)hostport:(NSInteger)port;

  • Undocumented

    Declaration

    Objective-C

    -(nonnullinstancetype)initSWIFT_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    +(nonnullinstancetype)newSWIFT_UNAVAILABLE_MSG("-init is unavailable");

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

Last updated 2022-10-10 UTC.