Trang này chứa danh sách các lớp, phương thức và kiểu liệt kê có trong API Bộ chọn của Google. Tất cả các phần tử này đều thuộc không gian tên google.picker.*
Có 2 loại lớp và loại được liệt kê: loại dùng để tạo và định cấu hình Bộ chọn của Google và loại mà Bộ chọn của Google trả về sau khi người dùng đã chọn một mục.
Lớp và loại cấu hình
Các lớp và kiểu liệt kê sau đây được dùng để tạo và định cấu hình Bộ chọn của Google.
DocsUploadView
Sử dụng DocsUploadView để tải tài liệu lên Google Drive.
DocsUploadView() | Hàm khởi tạo. |
DocsUploadView.setIncludeFolders(boolean) | Cho phép người dùng chọn một thư mục trong Google Drive để tải lên. |
DocsUploadView.setParent(string) | Đặt đích tải lên vào thư mục đã chỉ định. Thao tác này sẽ ghi đè setIncludeFolders thành false. |
DocsView
DocsView là một lớp con của View có thể dùng cho chế độ xem Google Drive.
DocsView(ViewId | undefined) | Hàm khởi tạo. ViewId phải là một trong các chế độ xem Google Drive. Mặc định là ViewId.DOCS. |
DocsView.setEnableDrives(boolean) | Hiện bộ nhớ dùng chung và các tệp trong đó. Trước khi bật, hãy tham khảo Tài liệu về API Google Drive để bật bộ nhớ dùng chung. |
DocsView.setIncludeFolders(boolean) | Hiển thị các thư mục trong thành phần hiển thị các mục. Không kết hợp với setOwnedByMe. Khi bạn đặt setIncludeFolders(true), setOwnedByMe sẽ bị bỏ qua. |
DocsView.setSelectFolderEnabled(boolean) | Cho phép người dùng chọn một thư mục trong Google Drive. |
DocsView.setMode(DocsViewMode) | Chọn chế độ mà chế độ xem dùng để hiển thị tài liệu. |
DocsView.setOwnedByMe(boolean | undefined) | Lọc tài liệu dựa trên việc tài liệu thuộc sở hữu của người dùng hay được chia sẻ với người dùng. Đừng kết hợp chế độ cài đặt này với setIncludeFolders. Khi bạn đặt setIncludeFolders(true), setOwnedByMe sẽ bị bỏ qua. |
DocsView.setParent(string) | Đặt thư mục mẹ ban đầu mà bạn muốn hiển thị. |
DocsView.setStarred(boolean) | Lọc tài liệu dựa trên việc người dùng có gắn dấu sao hay không. |
DocsViewMode
DocsViewMode là một loại thuộc tính liệt kê để hiển thị dữ liệu trong DocumentView. Sử dụng các giá trị này trong các lệnh gọi đến DocsView.setMode.
DocsViewMode.GRID | Hiển thị tài liệu trong lưới hình thu nhỏ. |
DocsViewMode.LIST | Hiển thị tài liệu trong danh sách chi tiết. |
Tính năng
Feature là một loại thuộc tính liệt kê, dùng để bật/tắt các tính năng cho nhiều khung hiển thị. Sử dụng các giá trị này trong các lệnh gọi đến PickerBuilder.enableFeature và PickerBuilder.disableFeature.
Feature.MINE_ONLY | Chỉ hiển thị tài liệu do người dùng sở hữu khi hiển thị các mục từ Google Drive. |
Feature.MULTISELECT_ENABLED | Cho phép người dùng chọn nhiều mục. |
Feature.NAV_HIDDEN | Ẩn ngăn điều hướng. Nếu ngăn điều hướng bị ẩn, người dùng chỉ có thể chọn từ chế độ xem đầu tiên đã chọn. |
Feature.SIMPLE_UPLOAD_ENABLED | Đối với ảnh tải lên, bạn có thể kiểm soát việc có bật lựa chọn cho mỗi ảnh (thay vì mỗi đĩa nhạc) hay không. |
Feature.SUPPORT_DRIVES |
Không dùng nữa: Các mục trong bộ nhớ dùng chung hiện được đưa vào theo mặc định. Liệu các mục trên bộ nhớ dùng chung có được đưa vào kết quả hay không. |
Bộ chọn
Picker là đối tượng cấp cao nhất đại diện cho hành động trên giao diện người dùng với người dùng. Các đối tượng này không được tạo trực tiếp mà sử dụng đối tượng PickerBuilder.
Picker.isVisible() | Nhận giá trị boolean cho biết chế độ hiển thị hiện tại của Bộ chọn. |
Picker.setCallback(function(object)) | Chỉ định phương pháp gọi lại được gọi bất cứ khi nào người dùng đã chọn một mục (hoặc đã huỷ). |
Picker.setRelayUrl(string) | Chỉ định URL chuyển tiếp để tránh các sự cố giữa nhiều miền. |
Picker.setVisible(boolean) | Kiểm soát chế độ hiển thị của đối tượng Bộ chọn. |
Picker.dispose() | Loại bỏ đối tượng Bộ chọn. |
PickerBuilder
PickerBuilder được dùng để tạo các đối tượng Picker. Ngoại trừ những trường hợp có lưu ý khác, loại dữ liệu trả về bên dưới thuộc loại PickerBuilder, cho phép bạn liên kết từng lệnh gọi với nhau. Hãy xem mẫu mã Bộ chọn của Google để biết cách sử dụng thông thường.
PickerBuilder() | Hàm khởi tạo. |
PickerBuilder.addView( | Thêm View vào ngăn điều hướng. |
PickerBuilder.addViewGroup(ViewGroup) | Thêm ViewGroup vào ngăn điều hướng cấp cao nhất. |
PickerBuilder.build() | Xây dựng đối tượng Bộ chọn. Đối tượng Bộ chọn sẽ được trả về. |
PickerBuilder.disableFeature(Feature) | Tắt tính năng bộ chọn. |
PickerBuilder.enableFeature(Feature) | Bật tính năng bộ chọn. |
PickerBuilder.getRelayUrl() | Lấy URL chuyển tiếp, dùng cho tiện ích.rpc. |
PickerBuilder.getTitle() | Lấy tiêu đề hộp thoại. |
PickerBuilder.hideTitleBar() | Không cho hiển thị thanh tiêu đề. Để bật lại, hãy gọi setTitle với tiêu đề không trống hoặc không xác định. |
PickerBuilder.isFeatureEnabled(Feature) | Kiểm tra xem bạn đã bật một bộ chọn Feature hay chưa. |
PickerBuilder.setAppId(string) | Đặt Mã ứng dụng Google Drive cần thiết để cho phép ứng dụng truy cập vào tệp của người dùng thông qua API Google Drive. |
PickerBuilder.setCallback(method) | Đặt phương thức gọi lại. Phương thức này được gọi khi người dùng chọn các mục hoặc huỷ. Phương thức gọi lại nhận được một đối tượng gọi lại duy nhất. Cấu trúc của đối tượng gọi lại được mô tả trong Hướng dẫn về JSON. |
PickerBuilder.setDeveloperKey(string) | Đặt khoá API trình duyệt lấy từ Google API Console. Xem Hướng dẫn dành cho nhà phát triển để biết thông tin chi tiết về cách lấy khoá API trình duyệt. |
PickerBuilder.setDocument(document) | Đặt tài liệu. |
PickerBuilder.setLocale(string) | Mã ngôn ngữ ISO 639. Nếu ngôn ngữ không được hỗ trợ, hệ thống sẽ sử dụng en-US. Phương thức này cung cấp một phương án thay thế cho việc đặt ngôn ngữ tại thời điểm google.load(). Xem Hướng dẫn dành cho nhà phát triển để biết danh sách các ngôn ngữ được hỗ trợ. |
PickerBuilder.setMaxItems(number) | Đặt số lượng mục tối đa mà người dùng có thể chọn. |
PickerBuilder.setOAuthToken(string) | Đặt mã thông báo OAuth cần dùng để xác thực người dùng hiện tại. Tuỳ thuộc vào phạm vi của mã thông báo, chỉ một số chế độ xem nhất định mới hiển thị dữ liệu. Các phạm vi hợp lệ là Google Tài liệu và Drive. |
PickerBuilder.setOrigin(string) | Đặt nguồn gốc cho hộp thoại Bộ chọn của Google. Nguồn gốc phải được đặt thành window.location.protocol + '//' + window.location.host của trang trên cùng nếu ứng dụng của bạn đang chạy trong iframe. |
PickerBuilder.setRelayUrl(string) | Đặt URL chuyển tiếp, dùng cho tiện ích.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Thiết lập danh sách các loại MIME có thể chọn. Sử dụng dấu phẩy để phân tách các loại MIME nếu cần nhiều loại MIME. |
PickerBuilder.setSize() | Đặt kích thước hộp thoại ưu tiên. Hộp thoại được tự động căn giữa. Nó có kích thước tối thiểu là (566.350) và kích thước tối đa là (1051.650). |
PickerBuilder.setTitle(string) | Đặt tiêu đề hộp thoại. |
PickerBuilder.toUri() | Trả về URI do trình tạo này tạo. |
ResourceId
ResourceId là một lớp tĩnh dùng để tạo các mã nhận dạng tài nguyên phù hợp với API danh sách tài liệu của Google.
ResourceId.generate(Document) | Liên kết một đối tượng tài liệu với một mã nhận dạng tài nguyên. |
Xem
View là lớp cơ sở trừu tượng cho nhiều lớp Khung hiển thị, chẳng hạn như DocsView.
View(ViewId) | Hàm khởi tạo. |
View.getId() | Trả về ViewId của thành phần hiển thị này. |
View.setMimeTypes(string) | Thiết lập loại MIME có trong khung hiển thị. Sử dụng dấu phẩy để phân tách các loại MIME nếu cần nhiều loại MIME. Nếu bạn không đặt loại MIME, thì các tệp thuộc tất cả loại MIME sẽ hiển thị trong khung hiển thị. |
View.setQuery(string) | Đối với các chế độ xem liên quan đến tìm kiếm, hãy điền trước truy vấn tìm kiếm bằng các thuật ngữ này. |
ViewGroup
ViewGroup là một nhóm các chế độ xem hình ảnh. Mục gốc của chính ViewGroup phải là View.
ViewGroup(View | ViewId) | ViewGroup là một nhóm các chế độ xem hình ảnh trong ngăn điều hướng. Mục gốc của chính ViewGroup phải là View. |
ViewGroup.addLabel(string) | Thêm nhãn cho ViewGroup này. |
ViewGroup.addView(ViewId | View) | Thêm thành phần hiển thị vào ViewGroup. View có thể được biểu thị bằng một đối tượng bắt nguồn từ view hoặc đơn giản bằng ViewId. |
ViewGroup.addViewGroup(ViewGroup) | Lồng một ViewGroup trong ViewGroup hiện tại. |
ViewId
ViewId là một kiểu liệt kê, dùng để tạo các đối tượng View và ViewGroup.
ViewId.DOCS | Tất cả các loại tài liệu trên Google Drive. |
ViewId.DOCS_IMAGES | Ảnh trên Google Drive. |
ViewId.DOCS_IMAGES_AND_VIDEOS | Ảnh và video trên Google Drive. |
ViewId.DOCS_VIDEOS | Video trên Google Drive. |
ViewId.DOCUMENTS | Tài liệu trong Google Drive. |
ViewId.DRAWINGS | Bản vẽ trên Google Drive. |
ViewId.FOLDERS | Thư mục Google Drive. |
ViewId.FORMS | Biểu mẫu trên Google Drive. |
ViewId.PDFS | Tệp PDF được lưu trữ trong Google Drive. |
ViewId.PRESENTATIONS | Bản trình bày trên Google Drive. |
ViewId.SPREADSHEETS | Bảng tính Google Drive. |
Loại lệnh gọi lại
Bạn có thể tìm thấy các loại được liệt kê sau đây trong dữ liệu gọi lại do Google Picker API trả về.
Hành động
Action là một loại liệt kê đại diện cho hành động mà người dùng thực hiện để đóng hộp thoại. Giá trị này nằm ở trường Response.ACTION trong dữ liệu về lệnh gọi lại.
Action.CANCEL | Người dùng đã huỷ hộp thoại Bộ chọn của Google. |
Action.PICKED | Người dùng đã chọn ít nhất một mục. |
Tài liệu
Document là một kiểu liệt kê dùng để truyền tải thông tin về một mục cụ thể đã chọn. Chỉ những trường có liên quan đến mục đã chọn mới được trả về. Giá trị này nằm ở trường Response.DOCUMENTS trong dữ liệu về lệnh gọi lại.
Document.DESCRIPTION | Nội dung mô tả về mục đã chọn do người dùng đóng góp. |
Document.DURATION | Thời lượng của video đã chọn. |
Document.EMBEDDABLE_URL | URL cho mục này phù hợp để nhúng vào một trang web. |
Document.ICON_URL | URL đến biểu tượng của mục này. |
Document.ID | Mã của mục đã chọn. |
Document.IS_NEW | Trả về true nếu mục đã chọn vừa được tải lên. |
Document.LAST_EDITED_UTC | Dấu thời gian mô tả thời điểm mục này được chỉnh sửa lần gần đây nhất. |
Document.MIME_TYPE | Loại MIME của mục này. |
Document.NAME | Tên của mục này. |
Document.NUM_CHILDREN | Số lượng trẻ em có trong mục này. Ví dụ: số lượng tệp trong thư mục đã chọn. |
Document.PARENT_ID | Mã nhận dạng gốc của mục này. Ví dụ: thư mục chứa tệp này. |
Document.SERVICE_ID | ServiceId mô tả dịch vụ mà mặt hàng này được chọn. |
Document.THUMBNAILS | Một mảng Thumbnail mô tả các thuộc tính của một ảnh hoặc video. Hình thu nhỏ sẽ không được trả lại nếu các mục đã chọn thuộc về Google Drive. |
Document.TYPE | Type của mục đã chọn. |
Document.URL | URL đến mục này. |
Phản hồi
Response là một kiểu liệt kê dùng để truyền tải thông tin về các mục mà người dùng chọn.
Response.ACTION | Loại Action biểu thị hành động mà người dùng thực hiện để đóng hộp thoại. |
Response.DOCUMENTS | Một mảng Document do người dùng chọn. |
Response.PARENTS | Mã của thư mục mẹ cho những mục đã chọn. (Ví dụ: Mã nhận dạng của các thư mục mẹ có tệp đã được chọn.) |
Response.VIEW | View mà người dùng đã chọn các mục này. |
mã dịch vụ
ServiceId là một loại liệt kê dùng để mô tả dịch vụ mà mục được chọn. Giá trị này nằm trong trường Document.SERVICE_ID của Document đã chọn.
ServiceId.DOCS | Google Drive. |
hình thu nhỏ
Thumbnail là một kiểu liệt kê dùng để truyền tải thông tin về một ảnh hoặc video được chọn. Bạn có thể tìm thấy giá trị này trong trường Document.THUMBNAILS của Document đã chọn.
Thumbnail.HEIGHT | Chiều cao của ảnh hoặc video tính bằng pixel. |
Thumbnail.WIDTH | Chiều rộng của ảnh hoặc video tính bằng pixel. |
Thumbnail.URL | URL đến ảnh hoặc video đã chọn. |
loại
Type là một kiểu liệt kê dùng để phân loại mục đã chọn. Bạn có thể tìm thấy giá trị này trong trường Document.TYPE của Document đã chọn.
Type.DOCUMENT | Mục là một tài liệu. |
Type.PHOTO | Mục là ảnh. |
Type.VIDEO | Mục này là một video. |