Documentation

Google_Service_FirebaseManagement_Resource_ProjectsWebApps extends Google_Service_Resource
in package

The "webApps" collection of methods.

Typical usage is: $firebaseService = new Google_Service_FirebaseManagement(...); $webApps = $firebaseService->webApps;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_FirebaseManagement_Operation
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)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_FirebaseManagement_WebApp
Gets the specified WebApp. (webApps.get)
getConfig()  : Google_Service_FirebaseManagement_WebAppConfig
Gets the configuration artifact associated with the specified WebApp.
listProjectsWebApps()  : Google_Service_FirebaseManagement_ListWebAppsResponse
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()  : Google_Service_FirebaseManagement_WebApp
Updates the attributes of the specified WebApp. (webApps.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

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)

public create(string $parent, Google_Service_FirebaseManagement_WebApp $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_Operation
Parameters
$parent : string

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.

$postBody : Google_Service_FirebaseManagement_WebApp
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_FirebaseManagement_Operation

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

get()

Gets the specified WebApp. (webApps.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_WebApp
Parameters
$name : string

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.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_FirebaseManagement_WebApp

getConfig()

Gets the configuration artifact associated with the specified WebApp.

public getConfig(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_WebAppConfig

(webApps.getConfig)

Parameters
$name : string

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.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_FirebaseManagement_WebAppConfig

listProjectsWebApps()

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`.

public listProjectsWebApps(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_ListWebAppsResponse

(webApps.listProjectsWebApps)

Parameters
$parent : string

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.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize The maximum number of Apps to return in the response. The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

opt_param

string pageToken Token returned from a previous call to ListWebApps indicating where in the set of Apps to resume listing.

Return values
Google_Service_FirebaseManagement_ListWebAppsResponse

patch()

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

public patch(string $name, Google_Service_FirebaseManagement_WebApp $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_WebApp
Parameters
$name : string

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).

$postBody : Google_Service_FirebaseManagement_WebApp
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Specifies which fields to update. Note that the fields name, appId, and projectId are all immutable.

Return values
Google_Service_FirebaseManagement_WebApp

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results