@types/gapi.auth2
Advanced tools
Comparing version 0.0.42 to 0.0.43
@@ -110,2 +110,54 @@ // Type definitions for Google Sign-In API 0.0 | ||
/** | ||
* Interface that represents the different configuration parameters for the gapi.auth2.init method. | ||
* Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2clientconfig | ||
*/ | ||
interface ClientConfig { | ||
/** | ||
* The app's client ID, found and created in the Google Developers Console. | ||
*/ | ||
client_id?: string; | ||
/** | ||
* The domains for which to create sign-in cookies. Either a URI, single_host_origin, or none. | ||
* Defaults to single_host_origin if unspecified. | ||
*/ | ||
cookie_policy?: string; | ||
/** | ||
* The scopes to request, as a space-delimited string. Optional if fetch_basic_profile is not set to false. | ||
*/ | ||
scope?: string; | ||
/** | ||
* Fetch users' basic profile information when they sign in. Adds 'profile' and 'email' to the requested scopes. True if unspecified. | ||
*/ | ||
fetch_basic_profile?: boolean; | ||
/** | ||
* The Google Apps domain to which users must belong to sign in. This is susceptible to modification by clients, | ||
* so be sure to verify the hosted domain property of the returned user. Use GoogleUser.getHostedDomain() on the client, | ||
* and the hd claim in the ID Token on the server to verify the domain is what you expected. | ||
*/ | ||
hosted_domain?: string; | ||
/** | ||
* Used only for OpenID 2.0 client migration. Set to the value of the realm that you are currently using for OpenID 2.0, | ||
* as described in <a href="https://developers.google.com/accounts/docs/OpenID#openid-connect">OpenID 2.0 (Migration)</a>. | ||
*/ | ||
openid_realm?: string; | ||
/** | ||
* The UX mode to use for the sign-in flow. | ||
* By default, it will open the consent flow in a popup. | ||
*/ | ||
ux_mode?: "popup" | "redirect"; | ||
/** | ||
* If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. | ||
* The default redirect_uri is the current URL stripped of query parameters and hash fragment. | ||
*/ | ||
redirect_uri?: string; | ||
} | ||
class SigninOptionsBuilder { | ||
@@ -241,50 +293,8 @@ setAppPackageName(name: string): any; | ||
function init(params: { | ||
/** | ||
* The app's client ID, found and created in the Google Developers Console. | ||
*/ | ||
client_id?: string; | ||
/** | ||
* Initializes the GoogleAuth object. | ||
* Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2initparams | ||
*/ | ||
function init(params: ClientConfig): GoogleAuth; | ||
/** | ||
* The domains for which to create sign-in cookies. Either a URI, single_host_origin, or none. | ||
* Defaults to single_host_origin if unspecified. | ||
*/ | ||
cookie_policy?: string; | ||
/** | ||
* The scopes to request, as a space-delimited string. Optional if fetch_basic_profile is not set to false. | ||
*/ | ||
scope?: string; | ||
/** | ||
* Fetch users' basic profile information when they sign in. Adds 'profile' and 'email' to the requested scopes. True if unspecified. | ||
*/ | ||
fetch_basic_profile?: boolean; | ||
/** | ||
* The Google Apps domain to which users must belong to sign in. This is susceptible to modification by clients, | ||
* so be sure to verify the hosted domain property of the returned user. Use GoogleUser.getHostedDomain() on the client, | ||
* and the hd claim in the ID Token on the server to verify the domain is what you expected. | ||
*/ | ||
hosted_domain?: string; | ||
/** | ||
* Used only for OpenID 2.0 client migration. Set to the value of the realm that you are currently using for OpenID 2.0, | ||
* as described in <a href="https://developers.google.com/accounts/docs/OpenID#openid-connect">OpenID 2.0 (Migration)</a>. | ||
*/ | ||
openid_realm?: string; | ||
/** | ||
* The UX mode to use for the sign-in flow. | ||
* By default, it will open the consent flow in a popup. | ||
*/ | ||
ux_mode?: "popup" | "redirect"; | ||
/** | ||
* If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. | ||
* The default redirect_uri is the current URL stripped of query parameters and hash fragment. | ||
*/ | ||
redirect_uri?: string; | ||
}): GoogleAuth; | ||
/** | ||
@@ -291,0 +301,0 @@ * Returns the GoogleAuth object. You must initialize the GoogleAuth object with gapi.auth2.init() before calling this method. |
{ | ||
"name": "@types/gapi.auth2", | ||
"version": "0.0.42", | ||
"version": "0.0.43", | ||
"description": "TypeScript definitions for Google Sign-In API", | ||
@@ -22,4 +22,4 @@ "license": "MIT", | ||
"peerDependencies": {}, | ||
"typesPublisherContentHash": "84e817a5daa29eb4488d88f2c5d13af5e2989acce24015624aa8791b424a8ea6", | ||
"typesPublisherContentHash": "f843d265c1394fe9407cc31a1b2be20a4f7de881b76da744ddecb94fce6ceed8", | ||
"typeScriptVersion": "2.3" | ||
} |
@@ -11,3 +11,3 @@ # Installation | ||
Additional Details | ||
* Last updated: Tue, 08 Aug 2017 21:39:34 GMT | ||
* Last updated: Fri, 11 Aug 2017 13:42:09 GMT | ||
* Dependencies: gapi | ||
@@ -14,0 +14,0 @@ * Global values: gapi |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
13679
304