Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ApnSetting

import type { ApnSetting } from "https://googleapis.deno.dev/v1/androidmanagement:v1.ts";

An Access Point Name (APN) configuration for a carrier data connection. The APN provides configuration to connect a cellular network device to an IP data network. A carrier uses this setting to decide which IP address to assign, any security methods to apply, and how the device might be connected to private networks.

interface ApnSetting {

alwaysOnSetting?: "ALWAYS_ON_SETTING_UNSPECIFIED" | "NOT_ALWAYS_ON" | "ALWAYS_ON";

apn?: string;

apnTypes?:

| "APN_TYPE_UNSPECIFIED"

| "ENTERPRISE"

| "BIP"

| "CBS"

| "DEFAULT"

| "DUN"

| "EMERGENCY"

| "FOTA"

| "HIPRI"

| "IA"

| "IMS"

| "MCX"

| "MMS"

| "RCS"

| "SUPL"

| "VSIM"

| "XCAP"[];

authType?:

| "AUTH_TYPE_UNSPECIFIED"

| "NONE"

| "PAP"

| "CHAP"

| "PAP_OR_CHAP";

carrierId?: number;

displayName?: string;

mmsc?: string;

mmsProxyAddress?: string;

mmsProxyPort?: number;

mtuV4?: number;

mtuV6?: number;

mvnoType?:

| "MVNO_TYPE_UNSPECIFIED"

| "GID"

| "ICCID"

| "IMSI"

| "SPN";

networkTypes?:

| "NETWORK_TYPE_UNSPECIFIED"

| "EDGE"

| "GPRS"

| "GSM"

| "HSDPA"

| "HSPA"

| "HSPAP"

| "HSUPA"

| "IWLAN"

| "LTE"

| "NR"

| "TD_SCDMA"

| "UMTS"[];

numericOperatorId?: string;

password?: string;

protocol?:

| "PROTOCOL_UNSPECIFIED"

| "IP"

| "IPV4V6"

| "IPV6"

| "NON_IP"

| "PPP"

| "UNSTRUCTURED";

proxyAddress?: string;

proxyPort?: number;

roamingProtocol?:

| "PROTOCOL_UNSPECIFIED"

| "IP"

| "IPV4V6"

| "IPV6"

| "NON_IP"

| "PPP"

| "UNSTRUCTURED";

username?: string;

}

§Properties

alwaysOnSetting?: "ALWAYS_ON_SETTING_UNSPECIFIED" | "NOT_ALWAYS_ON" | "ALWAYS_ON"

Optional. Whether User Plane resources have to be activated during every transition from CM-IDLE mode to CM-CONNECTED state for this APN. See 3GPP TS 23.501 section 5.6.13.

apn?: string

Required. Name of the APN. Policy will be rejected if this field is empty.

apnTypes?: "APN_TYPE_UNSPECIFIED" | "ENTERPRISE" | "BIP" | "CBS" | "DEFAULT" | "DUN" | "EMERGENCY" | "FOTA" | "HIPRI" | "IA" | "IMS" | "MCX" | "MMS" | "RCS" | "SUPL" | "VSIM" | "XCAP"[]

Required. Usage categories for the APN. Policy will be rejected if this field is empty or contains APN_TYPE_UNSPECIFIED or duplicates. Multiple APN types can be set on fully managed devices. ENTERPRISE is the only allowed APN type on work profiles. A NonComplianceDetail with MANAGEMENT_MODE is reported for any other value on work profiles. APN types that are not supported on the device or management mode will be ignored. If this results in the empty list, the APN setting will be ignored, because apnTypes is a required field. A NonComplianceDetail with INVALID_VALUE is reported if none of the APN types are supported on the device or management mode.

authType?: "AUTH_TYPE_UNSPECIFIED" | "NONE" | "PAP" | "CHAP" | "PAP_OR_CHAP"

Optional. Authentication type of the APN.

carrierId?: number

Optional. Carrier ID for the APN. A value of 0 (default) means not set and negative values are rejected.

displayName?: string

Required. Human-readable name that describes the APN. Policy will be rejected if this field is empty.

mmsc?: string

Optional. MMSC (Multimedia Messaging Service Center) URI of the APN.

mmsProxyAddress?: string

Optional. MMS (Multimedia Messaging Service) proxy address of the APN which can be an IP address or hostname (not a URL).

mmsProxyPort?: number

Optional. MMS (Multimedia Messaging Service) proxy port of the APN. A value of 0 (default) means not set and negative values are rejected.

mtuV4?: number

Optional. The default MTU (Maximum Transmission Unit) size in bytes of the IPv4 routes brought up by this APN setting. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 13.

mtuV6?: number

Optional. The MTU (Maximum Transmission Unit) size of the IPv6 mobile interface to which the APN connected. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 13.

mvnoType?: "MVNO_TYPE_UNSPECIFIED" | "GID" | "ICCID" | "IMSI" | "SPN"

Optional. MVNO match type for the APN.

networkTypes?: "NETWORK_TYPE_UNSPECIFIED" | "EDGE" | "GPRS" | "GSM" | "HSDPA" | "HSPA" | "HSPAP" | "HSUPA" | "IWLAN" | "LTE" | "NR" | "TD_SCDMA" | "UMTS"[]

Optional. Radio technologies (network types) the APN may use. Policy will be rejected if this field contains NETWORK_TYPE_UNSPECIFIED or duplicates.

numericOperatorId?: string

Optional. The numeric operator ID of the APN. Numeric operator ID is defined as MCC (Mobile Country Code) + MNC (Mobile Network Code).

password?: string

Optional. APN password of the APN.

protocol?: "PROTOCOL_UNSPECIFIED" | "IP" | "IPV4V6" | "IPV6" | "NON_IP" | "PPP" | "UNSTRUCTURED"

Optional. The protocol to use to connect to this APN.

proxyAddress?: string

Optional. The proxy address of the APN.

proxyPort?: number

Optional. The proxy port of the APN. A value of 0 (default) means not set and negative values are rejected.

roamingProtocol?: "PROTOCOL_UNSPECIFIED" | "IP" | "IPV4V6" | "IPV6" | "NON_IP" | "PPP" | "UNSTRUCTURED"

Optional. The protocol to use to connect to this APN while the device is roaming.

username?: string

Optional. APN username of the APN.