alerts.appDistribution namespace

Functions

Function Description
onInAppFeedbackPublished(handler) Declares a function that can handle receiving new in-app feedback from a tester.
onInAppFeedbackPublished(appId, handler) Declares a function that can handle receiving new in-app feedback from a tester.
onInAppFeedbackPublished(opts, handler) Declares a function that can handle receiving new in-app feedback from a tester.
onNewTesterIosDevicePublished(handler) Declares a function that can handle adding a new tester iOS device.
onNewTesterIosDevicePublished(appId, handler) Declares a function that can handle adding a new tester iOS device.
onNewTesterIosDevicePublished(opts, handler) Declares a function that can handle adding a new tester iOS device.

Interfaces

Interface Description
AppDistributionEvent A custom CloudEvent for Firebase Alerts (with custom extension attributes).
AppDistributionOptions Configuration for app distribution functions.
InAppFeedbackPayload The internal payload object for receiving in-app feedback from a tester. Payload is wrapped inside a FirebaseAlertData object.
NewTesterDevicePayload The internal payload object for adding a new tester device to app distribution. Payload is wrapped inside a FirebaseAlertData object.

alerts.appDistribution.onInAppFeedbackPublished()

Declares a function that can handle receiving new in-app feedback from a tester.

Signature:

export declare function onInAppFeedbackPublished(handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;

Parameters

Parameter Type Description
handler (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any> Event handler which is run every time new feedback is received.

Returns:

CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>

A function that you can export and deploy.

alerts.appDistribution.onInAppFeedbackPublished()

Declares a function that can handle receiving new in-app feedback from a tester.

Signature:

export declare function onInAppFeedbackPublished(appId: string, handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;

Parameters

Parameter Type Description
appId string A specific application the handler will trigger on.
handler (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any> Event handler which is run every time new feedback is received.

Returns:

CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>

A function that you can export and deploy.

alerts.appDistribution.onInAppFeedbackPublished()

Declares a function that can handle receiving new in-app feedback from a tester.

Signature:

export declare function onInAppFeedbackPublished(opts: AppDistributionOptions, handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;

Parameters

Parameter Type Description
opts AppDistributionOptions Options that can be set on the function.
handler (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any> Event handler which is run every time new feedback is received.

Returns:

CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>

A function that you can export and deploy.

alerts.appDistribution.onNewTesterIosDevicePublished()

Declares a function that can handle adding a new tester iOS device.

Signature:

export declare function onNewTesterIosDevicePublished(handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;

Parameters

Parameter Type Description
handler (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any> Event handler which is run every time a new tester iOS device is added.

Returns:

CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>

A function that you can export and deploy.

alerts.appDistribution.onNewTesterIosDevicePublished()

Declares a function that can handle adding a new tester iOS device.

Signature:

export declare function onNewTesterIosDevicePublished(appId: string, handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;

Parameters

Parameter Type Description
appId string A specific application the handler will trigger on.
handler (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any> Event handler which is run every time a new tester iOS device is added.

Returns:

CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>

A function that you can export and deploy.

alerts.appDistribution.onNewTesterIosDevicePublished()

Declares a function that can handle adding a new tester iOS device.

Signature:

export declare function onNewTesterIosDevicePublished(opts: AppDistributionOptions, handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;

Parameters

Parameter Type Description
opts AppDistributionOptions Options that can be set on the function.
handler (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any> Event handler which is run every time a new tester iOS device is added.

Returns:

CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>

A function that you can export and deploy.