Class DeveloperMetadataFinder

DeveloperMetadataFinder

Search for developer metadata in a spreadsheet. To create new developer metadata finder use Range.createDeveloperMetadataFinder(), Sheet.createDeveloperMetadataFinder(), or Spreadsheet.createDeveloperMetadataFinder().

Methods

MethodReturn typeBrief description
find()DeveloperMetadata[]Executes this search and returns the matching metadata.
onIntersectingLocations()DeveloperMetadataFinderConfigures the search to consider intersecting locations that have metadata.
withId(id)DeveloperMetadataFinderLimits this search to consider only metadata that match the specified ID.
withKey(key)DeveloperMetadataFinderLimits this search to consider only metadata that match the specified key.
withLocationType(locationType)DeveloperMetadataFinderLimits this search to consider only metadata that match the specified location type.
withValue(value)DeveloperMetadataFinderLimits this search to consider only metadata that match the specified value.
withVisibility(visibility)DeveloperMetadataFinderLimits this search to consider only metadata that match the specified visibility.

Detailed documentation

find()

Executes this search and returns the matching metadata.

Return

DeveloperMetadata[] — The developer metadata that match the search criteria.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

onIntersectingLocations()

Configures the search to consider intersecting locations that have metadata. This option is only valid for range-scoped searches.

Return

DeveloperMetadataFinder — The developer metadata finder, for chaining.


withId(id)

Limits this search to consider only metadata that match the specified ID.

Parameters

NameTypeDescription
idIntegerThe ID to match when searching for metadata.

Return

DeveloperMetadataFinder — The developer metadata finder, for chaining.


withKey(key)

Limits this search to consider only metadata that match the specified key.

Parameters

NameTypeDescription
keyStringThe key to match when searching for metadata.

Return

DeveloperMetadataFinder — The developer metadata finder, for chaining.


withLocationType(locationType)

Limits this search to consider only metadata that match the specified location type.

Parameters

NameTypeDescription
locationTypeDeveloperMetadataLocationTypeThe location type to match when searching for metadata.

Return

DeveloperMetadataFinder — The developer metadata finder, for chaining.


withValue(value)

Limits this search to consider only metadata that match the specified value.

Parameters

NameTypeDescription
valueStringThe value to match when searching for metadata.

Return

DeveloperMetadataFinder — The developer metadata finder, for chaining.


withVisibility(visibility)

Limits this search to consider only metadata that match the specified visibility.

Parameters

NameTypeDescription
visibilityDeveloperMetadataVisibilityThe visibility to match when searching for metadata.

Return

DeveloperMetadataFinder — The developer metadata finder, for chaining.

Şunun hakkında geri bildirim gönderin...

Yardım mı gerekiyor? Destek sayfamızı ziyaret edin.