Device groups

As funções do azion/applications que criam, listam, leem, atualizam e excluem os device groups de uma application.

Última atualização

Ver como Markdown Configurar agente

Um device group identifica dispositivos por uma expressão regular que a plataforma compara com o header de requisição User-Agent. Estas funções do azion/applications criam, listam, leem, atualizam e excluem os device groups de uma application.

createDeviceGroup

Cria um device group em uma application. Um device group identifica dispositivos por uma expressão regular que a plataforma compara com o header de requisição User-Agent.

TypeScript
01function createDeviceGroup(params: {
02 applicationId: number;
03 data: ApiCreateDeviceGroupPayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionDeviceGroup>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
data{ name: string; user_agent: string }Simname dá nome ao grupo, e user_agent contém a expressão regular, como Mobile|Android|iPhone.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como o AzionDeviceGroup criado. A API recusa um name que contenha um espaço ou um hífen. A função então retorna error com a mensagem HTTP error! Status: 400 - BAD REQUEST.

TypeScript
01import { createDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05// Create a new device group
06const deviceGroupData = {
07 name: 'MobileDevices',
08 user_agent: 'Mobile|Android|iPhone',
09};
10
11const { data: newDeviceGroup, error } = await createDeviceGroup({ applicationId, data: deviceGroupData });
12
13if (error) {
14 console.error('Error creating device group:', error);
15} else {
16 console.log('Device group created successfully:', newDeviceGroup);
17}

Saída:

Texto
01Device group created successfully: {
02 id: 1234,
03 name: 'MobileDevices',
04 user_agent: 'Mobile|Android|iPhone'
05}

getDeviceGroups

Lista os device groups de uma application, uma página por vez.

TypeScript
01function getDeviceGroups(params: {
02 applicationId: number;
03 params?: ApiListDeviceGroupsParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionDeviceGroup>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
paramsApiListDeviceGroupsParamsNãoPaginação: page e page_size.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna um AzionApplicationCollectionResponse cujo data.results contém objetos AzionDeviceGroup.

TypeScript
01import { getDeviceGroups } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05const { data: deviceGroups, error } = await getDeviceGroups({ applicationId, params: { page: 1, page_size: 20 } });
06
07if (error) {
08 console.error('Error listing device groups:', error);
09} else {
10 console.log(`Found ${deviceGroups?.count} device groups:`, deviceGroups?.results);
11}

Saída:

Texto
01Found 1 device groups: [
02 {
03 id: 1234,
04 name: 'MobileDevices',
05 user_agent: 'Mobile|Android|iPhone'
06 }
07]

getDeviceGroup

Retorna um device group de uma application pelo ID dele.

TypeScript
01function getDeviceGroup(params: {
02 applicationId: number;
03 deviceGroupId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionDeviceGroup>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
deviceGroupIdnumberSimO ID do device group.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como um AzionDeviceGroup.

TypeScript
01import { getDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const deviceGroupId = 1234; // Replace with the actual device group ID
05
06const { data: deviceGroup, error } = await getDeviceGroup({ applicationId, deviceGroupId });
07
08if (error) {
09 console.error('Error retrieving device group:', error);
10} else {
11 console.log('Device group details:', deviceGroup);
12}

Saída:

Texto
01Device group details: {
02 id: 1234,
03 name: 'MobileDevices',
04 user_agent: 'Mobile|Android|iPhone'
05}

updateDeviceGroup

Envia em uma requisição PATCH os campos do device group que você passa. O novo name segue a mesma regra da criação: sem espaços e sem hífens.

TypeScript
01function updateDeviceGroup(params: {
02 applicationId: number;
03 deviceGroupId: number;
04 data: ApiUpdateDeviceGroupPayload;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionDeviceGroup>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
deviceGroupIdnumberSimO ID do device group a atualizar.
data{ name?: string; user_agent?: string }SimOs campos a mudar.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como o AzionDeviceGroup atualizado.

TypeScript
01import { updateDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const deviceGroupId = 1234; // Replace with the actual device group ID
05
06const { data: updatedDeviceGroup, error } = await updateDeviceGroup({
07 applicationId,
08 deviceGroupId,
09 data: { name: 'MobileAndTablets', user_agent: 'Mobile|Android|iPhone|iPad' },
10});
11
12if (error) {
13 console.error('Error updating device group:', error);
14} else {
15 console.log('Device group updated:', updatedDeviceGroup);
16}

Saída:

Texto
01Device group updated: {
02 id: 1234,
03 name: 'MobileAndTablets',
04 user_agent: 'Mobile|Android|iPhone|iPad'
05}

deleteDeviceGroup

Exclui um device group de uma application pelo ID dele.

TypeScript
01function deleteDeviceGroup(params: {
02 applicationId: number;
03 deviceGroupId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
deviceGroupIdnumberSimO ID do device group a excluir.
optionsAzionClientOptionsNãoOpções de requisição.

Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo lê o device group de volta com getDeviceGroup. Um erro 404 confirma a exclusão.

TypeScript
01import { deleteDeviceGroup, getDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const deviceGroupId = 1234; // Replace with the actual device group ID
05
06const { error: deleteError } = await deleteDeviceGroup({ applicationId, deviceGroupId });
07
08// On success (HTTP 204) the envelope still carries an error, so confirm by reading it back
09const { error } = await getDeviceGroup({ applicationId, deviceGroupId });
10if (error) {
11 console.log(`Device group ${deviceGroupId} deleted (read back: ${error.message})`);
12} else {
13 console.error('Error deleting device group:', deleteError);
14}

Saída:

Device group 1234 deleted (read back: HTTP error! Status: 404 - NOT FOUND)

Recursos relacionados

Azion Lib

Os módulos da Azion Lib e o pacote npm em que cada um é distribuído.

Applications

A autenticação do módulo, o envelope de resposta dele e os erros que as funções reportam.

Tipos de application

Os tipos de payload e de resposta que estas funções recebem e retornam.

Device groups

O device group que uma application identifica pelo User-Agent.