GoogleSignIn Framework Reference

  • This documentation details classes for Google Sign-In on iOS, including configuration, user representation, and sign-in management.

  • GIDSignIn is the primary class for initiating and managing user sign-in with Google accounts.

  • GIDGoogleUser and GIDProfileData represent signed-in users and their basic profile information.

  • GIDSignInButton provides a pre-built "Sign in with Google" button for easy integration.

  • Developers can utilize GIDConfiguration to customize the client configuration for their application.

Classes

The following classes are available globally.

  • This class represents the client configuration provided by the developer.

    Declaration

    Swift

    class GIDConfiguration : NSObject, NSCopying, NSSecureCoding

    Objective-C

    @interface GIDConfiguration : NSObject <NSCopying, NSSecureCoding>

  • This class represents a signed-in user.

    Declaration

    Swift

    class GIDGoogleUser : NSObject, NSSecureCoding

    Objective-C

    @interface GIDGoogleUser : NSObject <NSSecureCoding>

  • This class represents the basic profile information of a GIDGoogleUser.

    Declaration

    Swift

    class GIDProfileData : NSObject, NSCopying, NSSecureCoding

    Objective-C

    @interface GIDProfileData : NSObject <NSCopying, NSSecureCoding>

  • This class is used to sign in users with their Google account and manage their session.

    For reference, please see “Google Sign-In for iOS and macOS” at https://developers.google.com/identity/sign-in/ios

    Declaration

    Swift

    class GIDSignIn : NSObject

    Objective-C

    @interface GIDSignIn : NSObject

  • This class provides the “Sign in with Google” button.

    You can instantiate this class programmatically or from a NIB file. You should connect this control to an IBAction, or something similar, that calls signInWithPresentingViewController:completion: on GIDSignIn and add it to your view hierarchy.

    Declaration

    Objective-C

    @interface GIDSignInButton : UIControl

  • A helper object that contains the result of a successful signIn or addScopes flow.

    Declaration

    Swift

    class GIDSignInResult : NSObject

    Objective-C

    @interface GIDSignInResult : NSObject

  • This class represents an OAuth2 or OpenID Connect token.

    Declaration

    Swift

    class GIDToken : NSObject, NSSecureCoding

    Objective-C

    @interface GIDToken : NSObject <NSSecureCoding>