Thư viện JavaScript cấp quyền của Google dành cho trang web – Tài liệu tham khảo API

Tài liệu tham khảo này mô tả API Thư viện JavaScript cho phép của Google bên thứ ba mà bạn có thể sử dụng để tải mã uỷ quyền hoặc mã truy cập từ Google.

Phương pháp: google.accounts.OAuth2.initCodeClient

Phương thức initCodeClient khởi chạy và trả về một ứng dụng mã, với các cấu hình trong tham số.

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

Loại dữ liệu: CodeClientConfig

Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu CodeClientConfig.

Loại dữ liệu: CodeClient

Lớp này chỉ có một phương thức công khai requestCode, phương thức này sẽ bắt đầu quy trình trải nghiệm người dùng của mã OAuth 2.0.

interface CodeClient {
  requestCode(): void;
}

Loại dữ liệu: CodeResponse

Đối tượng JavaScript CodeResponse sẽ được chuyển đến phương thức callback trong trải nghiệm người dùng bật lên. Trong trải nghiệm người dùng chuyển hướng, CodeResponse sẽ được chuyển dưới dạng tham số URL.

Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu CodeResponse.

Phương thức: google.accounts.OAuth2.initTokenClient

Phương thức initTokenClient khởi chạy và trả về một ứng dụng mã thông báo, với các cấu hình trong tham số.

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

Loại dữ liệu: TokenClientConfig

Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu TokenClientConfig.

Loại dữ liệu: TokenClient

Lớp này chỉ có một phương thức công khai requestAccessToken, phương thức này sẽ bắt đầu quy trình Trải nghiệm người dùng mã thông báo OAuth 2.0.

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}

Loại dữ liệu: OverridableTokenClientConfig

Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu OverridableTokenClientConfig.

Loại dữ liệu: TokenResponse

Đối tượng JavaScript TokenResponse sẽ được chuyển đến phương thức gọi lại của bạn trong trải nghiệm người dùng bật lên.

Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu TokenResponse.

Phương pháp: google.accounts.OAuth2.hasGrantedAllScopes

Kiểm tra xem người dùng đã cấp tất cả phạm vi hoặc phạm vi được chỉ định hay chưa.

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;

Phương thức: google.accounts.OAuth2.hasGrantedAnyScope

Kiểm tra xem người dùng có cấp bất kỳ phạm vi hoặc phạm vi nào được chỉ định hay không.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;

Phương thức: google.accounts.OAuth2.revoke

Phương thức revoke thu hồi tất cả phạm vi mà người dùng đã cấp cho ứng dụng. Cần có mã truy cập hợp lệ để thu hồi quyền.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;

Loại dữ liệu: RevocationResponse

Đối tượng JavaScript RevocationResponse sẽ được truyền đến phương pháp gọi lại của bạn.

Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu RevocationResponse.