GoogleSignin (Google Sign in component 1.0.1 API)

java.lang.Object
- com.vaadin.flow.component.Component
- - org.mikotin.googlesignin.GoogleSignin

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable
```
@Tag(value="google-signin")
 @HtmlImport(value="bower_components/google-signin/google-signin.html",
            loadMode=LAZY)
public class GoogleSignin
extends com.vaadin.flow.component.Component
```
A wrapper for google sign -web component, with some extra callbacks to actually get the user-data https://www.webcomponents.org/element/GoogleWebComponents/google-signin Basic usage: GoogleSignin signin = new GoogleSignin("your-google-client-id"); signin.addLoginListener(event -> { Notification.show("Welcome, " + event.getFirstName()); }); NOTE that, by default signin has auto-logout feature on, this mean that google-session is logged out instantly after successful login (well, first the session is used to get basic user information, but after that). This is to protect user browser from auto-log in via sign in button. But in some case you might want to turn of auto-logout

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GoogleSignin.Brand`
`static class`	`GoogleSignin.Height`
`static class`	`GoogleSignin.Theme`
`static class`	`GoogleSignin.Width`

Constructor Summary

Constructors
Constructor and Description

GoogleSignin(String clientId)

Constructors
Constructor and Description
`GoogleSignin(String clientId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.vaadin.flow.shared.Registration`	`addLoginListener(Consumer<UserLoginEvent> consumer)` Add listener for login action
`com.vaadin.flow.shared.Registration`	`addLogoutListener(Runnable action)` Add listener for logout action NOTE: logout listeners are NOT informed of logout action, if isAutoLogout is true
`String`	`getAppPackageName()` App package name for android over-the-air installs.
`GoogleSignin.Brand`	`getBrand()` The brand being used for logo and styling.
`String`	`getCookiePolicy()` The cookie policy defines what URIs have access to the session cookie remembering the user's sign-in state.
`boolean`	`getFill()` By default the ripple expands to fill the button.
`GoogleSignin.Height`	`getHeight()` The height to use for the button.
`String`	`getLabelAdditional()` An optional label for the button for additional permissions.
`String`	`getLabelSignin()` An optional label for the sign-in button.
`String`	`getLabelSignout()` An optional label for the sign-out button.
`boolean`	`getRaised()` If true, the button will be styled with a shadow.
`String`	`getScopes()` The scopes to provide access to (e.g https://www.googleapis.com/auth/drive) and should be space-delimited.
`GoogleSignin.Theme`	`getTheme()` The theme to use for the button.
`GoogleSignin.Width`	`getWidth()` The width to use for the button.
`boolean`	`isAutoLogout()` Tells if auto-logout is active: if auto-logout is on then the google login is closed after successful login.
`void`	`logout()` Logout current google login
`void`	`setAppPackageName(String value)`
`void`	`setAutoLogout(boolean autoLogout)`
`void`	`setBrand(GoogleSignin.Brand brand)`
`void`	`setCookiePolicy(String value)`
`void`	`setFill(boolean value)`
`void`	`setHeight(GoogleSignin.Height height)`
`void`	`setLabelAdditional(String value)`
`void`	`setLabelSignin(String value)`
`void`	`setLabelSignout(String value)`
`void`	`setRaised(boolean value)`
`void`	`setScopes(String value)`
`void`	`setTheme(GoogleSignin.Theme theme)`
`void`	`setWidth(GoogleSignin.Width width)`

Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener

- Constructor Detail
  - GoogleSignin
```
public GoogleSignin(String clientId)
```
- Method Detail
  - addLoginListener
```
public com.vaadin.flow.shared.Registration addLoginListener(Consumer<UserLoginEvent> consumer)
```
    Add listener for login action
    
    Parameters:
    
    consumer - that consumes the UserLoginEvent which has all user info
    
    Returns:
    
    hook for removing the listener
  - addLogoutListener
```
public com.vaadin.flow.shared.Registration addLogoutListener(Runnable action)
```
    Add listener for logout action NOTE: logout listeners are NOT informed of logout action, if isAutoLogout is true
    
    Parameters:
    
    action - Action to perform if logout is triggered
    
    Returns:
    
    hook for removing the listener
  - logout
```
public void logout()
```
    Logout current google login
  - isAutoLogout
```
public boolean isAutoLogout()
```
    Tells if auto-logout is active: if auto-logout is on then the google login is closed after successful login.
    
    Returns:
  - setAutoLogout
```
public void setAutoLogout(boolean autoLogout)
```
  - getBrand
```
public GoogleSignin.Brand getBrand()
```
    The brand being used for logo and styling.
  - setBrand
```
public void setBrand(GoogleSignin.Brand brand)
```
  - getWidth
```
public GoogleSignin.Width getWidth()
```
    The width to use for the button. Available options: iconOnly, standard, wide.
  - setWidth
```
public void setWidth(GoogleSignin.Width width)
```
  - getHeight
```
public GoogleSignin.Height getHeight()
```
    The height to use for the button. Available options: short, standard, tall.
  - setHeight
```
public void setHeight(GoogleSignin.Height height)
```
  - getTheme
```
public GoogleSignin.Theme getTheme()
```
    The theme to use for the button. Available options: light, dark.
  - setTheme
```
public void setTheme(GoogleSignin.Theme theme)
```
  - getAppPackageName
```
public String getAppPackageName()
```
    App package name for android over-the-air installs. See the relevant [docs](https://developers.google.com/+/web/signin/android-app-installs)
  - setAppPackageName
```
public void setAppPackageName(String value)
```
  - getCookiePolicy
```
public String getCookiePolicy()
```
    The cookie policy defines what URIs have access to the session cookie remembering the user's sign-in state. See the relevant [docs](https://developers.google.com/+/web/signin/reference#determining_a_value_for_cookie_policy) for more information.
  - setCookiePolicy
```
public void setCookiePolicy(String value)
```
  - getFill
```
public boolean getFill()
```
    By default the ripple expands to fill the button. Set this to true to constrain the ripple to a circle within the button.
  - setFill
```
public void setFill(boolean value)
```
  - getLabelAdditional
```
public String getLabelAdditional()
```
    An optional label for the button for additional permissions.
  - setLabelAdditional
```
public void setLabelAdditional(String value)
```
  - getLabelSignin
```
public String getLabelSignin()
```
    An optional label for the sign-in button.
  - setLabelSignin
```
public void setLabelSignin(String value)
```
  - getLabelSignout
```
public String getLabelSignout()
```
    An optional label for the sign-out button.
  - setLabelSignout
```
public void setLabelSignout(String value)
```
  - getRaised
```
public boolean getRaised()
```
    If true, the button will be styled with a shadow.
  - setRaised
```
public void setRaised(boolean value)
```
  - getScopes
```
public String getScopes()
```
    The scopes to provide access to (e.g https://www.googleapis.com/auth/drive) and should be space-delimited.
  - setScopes
```
public void setScopes(String value)
```

Class GoogleSignin

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.flow.component.Component

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

Constructor Detail

GoogleSignin

Method Detail

addLoginListener

addLogoutListener

logout

isAutoLogout

setAutoLogout

getBrand

setBrand

getWidth

setWidth

getHeight

setHeight

getTheme

setTheme

getAppPackageName

setAppPackageName

getCookiePolicy

setCookiePolicy

getFill

setFill

getLabelAdditional

setLabelAdditional

getLabelSignin

setLabelSignin

getLabelSignout

setLabelSignout

getRaised

setRaised

getScopes

setScopes