class ProjectsWebApps extends Resource (View source)

The "webApps" collection of methods.

Typical usage is:

 $firebaseService = new Google\Service\FirebaseManagement(...);
 $webApps = $firebaseService->projects_webApps;

Methods

create(string $parent, WebApp $postBody, array $optParams = [])

Requests the creation of a new WebApp in the specified FirebaseProject. The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation. (webApps.create)

get(string $name, array $optParams = [])

Gets the specified WebApp. (webApps.get)

getConfig(string $name, array $optParams = [])

Gets the configuration artifact associated with the specified WebApp.

listProjectsWebApps(string $parent, array $optParams = [])

Lists each WebApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

patch(string $name, WebApp $postBody, array $optParams = [])

Updates the attributes of the specified WebApp. (webApps.patch)

remove(string $name, RemoveWebAppRequest $postBody, array $optParams = [])

Removes the specified WebApp from the FirebaseProject. (webApps.remove)

undelete(string $name, UndeleteWebAppRequest $postBody, array $optParams = [])

Restores the specified WebApp to the FirebaseProject. (webApps.undelete)

Details

Operation create(string $parent, WebApp $postBody, array $optParams = [])

Requests the creation of a new WebApp in the specified FirebaseProject. The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation. (webApps.create)

Parameters

string $parent

The resource name of the parent FirebaseProject in which to create a WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

WebApp $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

WebApp get(string $name, array $optParams = [])

Gets the specified WebApp. (webApps.get)

Parameters

string $name

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the WebApp name field for details about PROJECT_IDENTIFIER and APP_ID values.

array $optParams

Optional parameters.

Return Value

WebApp

Exceptions

Exception

WebAppConfig getConfig(string $name, array $optParams = [])

Gets the configuration artifact associated with the specified WebApp.

(webApps.getConfig)

Parameters

string $name

The resource name of the WebApp configuration to download, in the format: projects/PROJECT_IDENTIFIER/webApps/APP_ID/config Since an APP_ID is a unique identifier, the Unique Resource from Sub- Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the WebApp name field for details about PROJECT_IDENTIFIER and APP_ID values.

array $optParams

Optional parameters.

Return Value

WebAppConfig

Exceptions

Exception

ListWebAppsResponse listProjectsWebApps(string $parent, array $optParams = [])

Lists each WebApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

(webApps.listProjectsWebApps)

Parameters

string $parent

The resource name of the parent FirebaseProject for which to list each associated WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

array $optParams

Optional parameters.

Return Value

ListWebAppsResponse

Exceptions

Exception

WebApp patch(string $name, WebApp $postBody, array $optParams = [])

Updates the attributes of the specified WebApp. (webApps.patch)

Parameters

string $name

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).

WebApp $postBody
array $optParams

Optional parameters.

Return Value

WebApp

Exceptions

Exception

Operation remove(string $name, RemoveWebAppRequest $postBody, array $optParams = [])

Removes the specified WebApp from the FirebaseProject. (webApps.remove)

Parameters

string $name

Required. The resource name of the WebApp, in the format: projects/ PROJECT_IDENTIFIER/webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the WebApp name field for details about PROJECT_IDENTIFIER and APP_ID values.

RemoveWebAppRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation undelete(string $name, UndeleteWebAppRequest $postBody, array $optParams = [])

Restores the specified WebApp to the FirebaseProject. (webApps.undelete)

Parameters

string $name

Required. The resource name of the WebApp, in the format: projects/ PROJECT_IDENTIFIER/webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the WebApp name field for details about PROJECT_IDENTIFIER and APP_ID values.

UndeleteWebAppRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception