getStoreLayout method

Future<StoreLayout> getStoreLayout(
  1. String enterpriseId, {
  2. String? $fields,
})

Returns the store layout for the enterprise.

If the store layout has not been set, returns "basic" as the store layout type and no homepage.

Request parameters:

enterpriseId - The ID of the enterprise.

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

Completes with a StoreLayout.

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<StoreLayout> getStoreLayout(
  core.String enterpriseId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'androidenterprise/v1/enterprises/' +
      commons.escapeVariable('$enterpriseId') +
      '/storeLayout';

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