SignIn class abstract

Lazy SignIn

  • Build in listener for account status change, and a SignInMsg notifier msg
Mixed in types
Implementers

Constructors

SignIn({required String clientId, bool debugLog = false, List<String> scopes = const ['email']})
  • clientId
    • use Google OAuth Web Application Client Id for webpage, moz-extension
    • use Google Oauth Chrome Application Client Id for chrome-extension and standalone app
    • cannot be empty
  • scopes : scopes for OAuth signin
    • Default ['email'] for Google api
  • debugLog : force print of log message. Default false

    • Properties

    clientId → String
  • Chrome Extension
    • use Google OAuth Chrome Application client id.
    • update OAuth credential app id with extension id
  • Firefox Extension
    • use Google OAuth Web Application client id.
    • update OAuth credential authorized redirect uri this can be obtain by redirectUrl
  • Web
    • use Google OAuth Web Application client id.
    • update OAuth credential authorized javaScript origins
  • Standalone App
    • use Google OAuth Chrome Application client id.
    • update OAuth credential app id
    • final
    debugLog ↔ bool
    getter/setter pair
    displayName → String
    Return username
    no setter
    hashCode → int
    The hash code for this object.
    no setterinherited
    hasListeners → bool
    Whether any listeners are currently registered.
    no setterinherited
    isSignedIn ↔ ValueNotifier<bool>
    Trigger whenever signin status changes.
    getter/setter pair
    photoUrl → String
    Return sign in account avatar url
    no setter
    redirectUrl → String
    Return redirectUri(only applicable for extension)
    no setter
    runtimeType → Type
    A representation of the runtime type of the object.
    no setterinherited
    scopes → List<String>
    scopes of sign-in
    final
    token ↔ ValueNotifier<String>
    Update by authorize()
    getter/setter pair

    Methods

    addListener(VoidCallback listener) → void
    Register a closure to be called when the object changes.
    inherited
    authorize() → Future<bool>
    dispose() → void
    Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
    inherited
    noSuchMethod(Invocation invocation) → dynamic
    Invoked when a nonexistent method or property is accessed.
    inherited
    notifyListeners() → void
    Call all the registered listeners.
    inherited
    removeListener(VoidCallback listener) → void
    Remove a previously registered closure from the list of closures that are notified when the object changes.
    inherited
    signIn({bool reAuthenticate = true, bool suppressErrors = true, bool silentOnly = false}) → Future
  • Return access token if sign-in successful,
  • Return empty if sign in failed
    • signOut() → Future
  • token return should always be empty
    • toString() → String
    A string representation of this object.
    inherited

    Operators

    operator ==(Object other) → bool
    The equality operator.
    inherited