Packagecom.adobe.csxs.types
Classpublic class NetworkPreferences

Stores preferences related to network connection. For an extension to be online, all of these preferences values must be true.



Public Properties
 PropertyDefined by
  adminOnlinePreference : Boolean
Retrieves the online preference for administrative users.
NetworkPreferences
  isAppOnline : Boolean
Retrieves the hosting application's online preference for extensions.
NetworkPreferences
  overallOnlinePreference : Boolean
[read-only] Reports whether online access is allowed by current network preference values.
NetworkPreferences
  userOnlinePreference : Boolean
Retrieves the online preference for the current user.
NetworkPreferences
Public Methods
 MethodDefined by
  
NetworkPreferences(isAppOnline:Boolean = false, userOnlinePreference:Boolean = false, adminOnlinePreference:Boolean = false)
Creates a network-preferences object.
NetworkPreferences
  
toString():String
Creates a string that contains all the properties of this object.
NetworkPreferences
Property detail
adminOnlinePreferenceproperty
adminOnlinePreference:Boolean  [read-write]

Retrieves the online preference for administrative users.

This property can be used as the source for data binding.

Implementation
    public function get adminOnlinePreference():Boolean
    public function set adminOnlinePreference(value:Boolean):void
isAppOnlineproperty 
isAppOnline:Boolean  [read-write]

Retrieves the hosting application's online preference for extensions.

This property can be used as the source for data binding.

Implementation
    public function get isAppOnline():Boolean
    public function set isAppOnline(value:Boolean):void
overallOnlinePreferenceproperty 
overallOnlinePreference:Boolean  [read-only]

Reports whether online access is allowed by current network preference values.

This property can be used as the source for data binding.

Implementation
    public function get overallOnlinePreference():Boolean
userOnlinePreferenceproperty 
userOnlinePreference:Boolean  [read-write]

Retrieves the online preference for the current user.

This property can be used as the source for data binding.

Implementation
    public function get userOnlinePreference():Boolean
    public function set userOnlinePreference(value:Boolean):void
Constructor detail
NetworkPreferences()constructor
public function NetworkPreferences(isAppOnline:Boolean = false, userOnlinePreference:Boolean = false, adminOnlinePreference:Boolean = false)

Creates a network-preferences object.

Parameters
isAppOnline:Boolean (default = false) — True if the hosting application allows extensions to go online.
 
userOnlinePreference:Boolean (default = false) — True if the current user is allowed to go online.
 
adminOnlinePreference:Boolean (default = false) — True if an administrative user is allowed to go online.
Method detail
toString()method
public function toString():String

Creates a string that contains all the properties of this object.

Returns
String — The properties string.