Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

allowedBands?: number

Bitfield of allowed frequency bands. Note that not all devices allow frequency band control. Permitted values are those specified by #NMSettingGsmNetworkBand.

apn?: string

The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.

homeOnly?: boolean

When %TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.

name?: string

The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".

networkId?: string

The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.

networkType?: number

Network preference to force the device to only use specific network technologies. The permitted values are %NM_SETTING_GSM_NETWORK_TYPE_ANY, %NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA, %NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE, %NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA, %NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE, %NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G, and %NM_SETTING_GSM_NETWORK_TYPE_4G. Note that not all devices allow network preference control.

number?: string

Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.

password?: string

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

passwordFlags?: number

Flags indicating how to handle the #NMSettingGsm:password property.

pin?: string

If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.

pinFlags?: number

Flags indicating how to handle the #NMSettingGsm:pin property.

username?: string

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method