searchApps method

Future<SearchFirebaseAppsResponse> searchApps(String parent, { String? filter, int? pageSize, String? pageToken, bool? showDeleted, String? $fields, })

Lists all available Apps for the specified FirebaseProject.

This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).

Request parameters:

parent - The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER Refer to the FirebaseProject [name](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. Value must have pattern ^projects/\[^/\]+$.

filter - A query string compatible with Google's [AIP-160 standard](https://google.aip.dev/160). Use any of the following fields in a query: * [app_id](../projects/searchApps#FirebaseAppInfo.FIELDS.app_id) * [namespace](../projects/searchApps#FirebaseAppInfo.FIELDS.namespace) * [platform](../projects/searchApps#FirebaseAppInfo.FIELDS.platform) This query also supports the following "virtual" fields. These are fields which are not actually part of the returned resource object, but they can be queried as if they are pre-populated with specific values. * sha1_hash or sha1_hashes: This field is considered to be a repeated string field, populated with the list of all SHA-1 certificate fingerprints registered with the AndroidApp. This list is empty if the App is not an AndroidApp. * sha256_hash or sha256_hashes: This field is considered to be a repeated string field, populated with the list of all SHA-256 certificate fingerprints registered with the AndroidApp. This list is empty if the App is not an AndroidApp. * app_store_id: This field is considered to be a singular string field, populated with the Apple App Store ID registered with the IosApp. This field is empty if the App is not an IosApp. * team_id: This field is considered to be a singular string field, populated with the Apple team ID registered with the IosApp. This field is empty if the App is not an IosApp.

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. This value cannot be negative.

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

showDeleted - Controls whether Apps in the DELETED state should be returned. If not specified, only ACTIVE Apps will be returned.

$fields - Selector specifying which fields to include in a partial response.

Completes with a SearchFirebaseAppsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<SearchFirebaseAppsResponse> searchApps(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.bool? showDeleted,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (showDeleted != null) 'showDeleted': ['${showDeleted}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1beta1/' + core.Uri.encodeFull('$parent') + ':searchApps';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return SearchFirebaseAppsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}