Packagecom.myflashlab.air.extensions.gSignIn
Classpublic class GSignInOptions
InheritanceGSignInOptions Inheritance Object

GSignInOptions is options used to configure the default GSignin behaviour.


Public Properties
 PropertyDefined By
  clientIdForiOS : String
[write-only] (on iOS only) The client ID of the app from the Google APIs console.
GSignInOptions
  forceCodeForRefreshToken : Boolean
[write-only] (on Android only) If true, the granted code can be exchanged for an access token and a refresh token.
GSignInOptions
  gamesSignIn : Boolean
[write-only] (on Android only) If true, Google signin flow will be set to DEFAULT_GAMES_SIGN_IN which is useful when working with Google Games Services and you want to have the minimum signin permissions required for the game services ANE only.
GSignInOptions
  language : String
[write-only] (on iOS only) The language for sign-in, in the form of ISO 639-1 language code optionally followed by a dash and ISO 3166-1 alpha-2 region code, such as "it" or "pt-PT".
GSignInOptions
  openIDRealm : String
[write-only] (on iOS only) The OpenID2 realm of the home web server.
GSignInOptions
  requestEmail : Boolean
[write-only] Specifies that email info is requested by your application.
GSignInOptions
  requestId : Boolean
[write-only] Specifies that user ID is requested by your application.
GSignInOptions
  requestIdToken : String
[write-only] Specifies that an ID token for authenticated users is requested.
GSignInOptions
  requestProfile : Boolean
[write-only] Specifies that user's profile info is requested by your application.
GSignInOptions
  requestScopes : Array
[write-only] Specifies OAuth 2.0 scopes your application requests.
GSignInOptions
  requestServerAuthCode : String
[write-only] Specifies that offline access is requested.
GSignInOptions
  setAccountName : String
[write-only] Specifies an account name on the device that should be used.
GSignInOptions
  setHostedDomain : String
[write-only] Specifies a hosted domain restriction.
GSignInOptions
Public Methods
 MethodDefined By
  
GSignInOptions()
constructor for a new instance of this class.
GSignInOptions
Property Detail
clientIdForiOSproperty
clientIdForiOS:String  [write-only]

(on iOS only) The client ID of the app from the Google APIs console. Must set for sign-in to work.


Implementation
    public function set clientIdForiOS(value:String):void
forceCodeForRefreshTokenproperty 
forceCodeForRefreshToken:Boolean  [write-only]

(on Android only) If true, the granted code can be exchanged for an access token and a refresh token. The first time you retrieve a code, a refresh_token will be granted automatically. Subsequent requests will require additional user consent. Use false by default; only use true if your server has suffered some failure and lost the user's refresh token.

Note that this works only if you have set requestServerAuthCode


Implementation
    public function set forceCodeForRefreshToken(value:Boolean):void
gamesSignInproperty 
gamesSignIn:Boolean  [write-only]

(on Android only) If true, Google signin flow will be set to DEFAULT_GAMES_SIGN_IN which is useful when working with Google Games Services and you want to have the minimum signin permissions required for the game services ANE only.


Implementation
    public function set gamesSignIn(value:Boolean):void
languageproperty 
language:String  [write-only]

(on iOS only) The language for sign-in, in the form of ISO 639-1 language code optionally followed by a dash and ISO 3166-1 alpha-2 region code, such as "it" or "pt-PT". Only set if different from system default.


Implementation
    public function set language(value:String):void
openIDRealmproperty 
openIDRealm:String  [write-only]

(on iOS only) The OpenID2 realm of the home web server. This allows Google to include the user's OpenID Identifier in the OpenID Connect ID token.


Implementation
    public function set openIDRealm(value:String):void
requestEmailproperty 
requestEmail:Boolean  [write-only]

Specifies that email info is requested by your application. Note that we don't recommend keying user by email address since email address might change. Keying user by ID is the preferable approach.


Implementation
    public function set requestEmail(value:Boolean):void
requestIdproperty 
requestId:Boolean  [write-only]

Specifies that user ID is requested by your application.


Implementation
    public function set requestId(value:Boolean):void
requestIdTokenproperty 
requestIdToken:String  [write-only]

Specifies that an ID token for authenticated users is requested. Requesting an ID token requires that the server client ID be specified.

get the client ID of your server from here https://console.developers.google.com/apis/credentials. its type is Web application.


Implementation
    public function set requestIdToken(value:String):void
requestProfileproperty 
requestProfile:Boolean  [write-only]

Specifies that user's profile info is requested by your application.


Implementation
    public function set requestProfile(value:Boolean):void
requestScopesproperty 
requestScopes:Array  [write-only]

Specifies OAuth 2.0 scopes your application requests. See the GScopes class for more information.

It is recommended to ignore this setter when you first try to signin users. Later when your app really needs the additional permissions, you can use GSignIn.requestPermissions


Implementation
    public function set requestScopes(value:Array):void
requestServerAuthCodeproperty 
requestServerAuthCode:String  [write-only]

Specifies that offline access is requested. Requesting offline access requires that the server client ID be specified. You don't need to use requestIdToken when you use this option. When your server exchanges the code for tokens, an ID token will be returned together (as long as you either use requestEmail or requestProfile along with your configuration).

The first time you retrieve a code, a refresh_token will be granted automatically. Subsequent requests will only return codes that can be exchanged for access token.

get the client ID of your server from here https://console.developers.google.com/apis/credentials. its type is Web application.


Implementation
    public function set requestServerAuthCode(value:String):void
setAccountNameproperty 
setAccountName:String  [write-only]

Specifies an account name on the device that should be used. If this is never called, the client will use the current default account for this application.


Implementation
    public function set setAccountName(value:String):void
setHostedDomainproperty 
setHostedDomain:String  [write-only]

Specifies a hosted domain restriction. By setting this, sign in will be restricted to accounts of the user in the specified domain.


Implementation
    public function set setHostedDomain(value:String):void
Constructor Detail
GSignInOptions()Constructor
public function GSignInOptions()

constructor for a new instance of this class. You must create a new instance, set the default options then pass it to the GSignIn.init(options); method.




myflashlabs.com - Best collection of ANEs

Thu May 21 2020, 09:16 AM +04:30