Class ValueMetadata

ValorMetadados

Um valueMetadata contém informações sobre os valores possíveis de uma variável.

Disponível apenas para complementos do Google Workspace que estendem o Google Workspace Studio.

Exemplo de uso:

let allowedValue1 = "001";
let allowedValue2 = "002";

const valueMetadata = AddOnsResponseService.newValueMetadata()
   .addEnumValue(allowedValue1);
   .addEnumValue(allowedValue2)
   .setDefaultValue(allowedValue1)
   .addCastableType(AddOnsResponseService.BasicDataType.STRING)
   .addCastableType(AddOnsResponseService.BasicDataType.INTEGER);

Métodos

MétodoTipo de retornoBreve descrição
addCastableType(dataType)ValueMetadataAdiciona tipos permitidos opcionais que podem ser transmitidos dinamicamente para um dado de variável a esses metadados de valor.
addEnumValue(enumValue)ValueMetadataAdiciona um valor de string opcional aos valores de enumeração permitidos de uma variável. Esse campo só pode ser definido se o DataType estiver definido como o tipo String.
setDefaultValue(defaultValue)ValueMetadataDefine o valor padrão opcional da variável. Por exemplo, se o tipo de variável for booleano, o defaultValue poderá ser definido como "true" ou "false".

Documentação detalhada

addCastableType(dataType)

Adiciona tipos permitidos opcionais que podem ser transmitidos dinamicamente para um dado de variável a esses metadados de valor.

Parâmetros

NomeTipoDescrição
dataTypeBasicDataTypeUm BasicDataType para o qual a variável pode ser convertida.

Retornar

ValueMetadata: esse objeto de metadados de valor, para encadeamento.


addEnumValue(enumValue)

Adiciona um valor de string opcional aos valores de enumeração permitidos de uma variável. Esse campo só pode ser definido se o DataType estiver definido como o tipo String.

Parâmetros

NomeTipoDescrição
enumValueStringO valor permitido a ser adicionado à enumeração.

Retornar

ValueMetadata: esse objeto de metadados de valor, para encadeamento.


setDefaultValue(defaultValue)

Define o valor padrão opcional da variável. Por exemplo, se o tipo de variável for booleano, o defaultValue poderá ser definido como "true" ou "false".

Parâmetros

NomeTipoDescrição
defaultValueStringO valor padrão da variável.

Retornar

ValueMetadata: esse objeto de metadados de valor, para encadeamento.