target.apidocs.com.google.api.services.drive.model.App.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-drive Show documentation

There is a newer version: v3-rev20241027-2.0.0

Show newest version







App (Google Drive API v3-rev20240914-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.drive.model
Class App



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.drive.model.App













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class App
extends com.google.api.client.json.GenericJson
The `apps` resource provides a list of apps that a user has installed, with information about
 each app's supported MIME types, file extensions, and other details. Some resource methods (such
 as `apps.get`) require an `appId`. Use the `apps.list` method to retrieve the ID for an installed
 application.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Google Drive API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


App() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


App
clone() 


Boolean
getAuthorized()
Whether the app is authorized to access data on the user's Drive.



String
getCreateInFolderTemplate()
The template URL to create a file with this app in a given folder.



String
getCreateUrl()
The URL to create a file with this app.



Boolean
getHasDriveWideScope()
Whether the app has Drive-wide scope.



List<AppIcons>
getIcons()
The various icons for the app.



String
getId()
The ID of the app.



Boolean
getInstalled()
Whether the app is installed.



String
getKind()
Output only.



String
getLongDescription()
A long description of the app.



String
getName()
The name of the app.



String
getObjectType()
The type of object this app creates such as a Chart.



String
getOpenUrlTemplate()
The template URL for opening files with this app.



List<String>
getPrimaryFileExtensions()
The list of primary file extensions.



List<String>
getPrimaryMimeTypes()
The list of primary MIME types.



String
getProductId()
The ID of the product listing for this app.



String
getProductUrl()
A link to the product listing for this app.



List<String>
getSecondaryFileExtensions()
The list of secondary file extensions.



List<String>
getSecondaryMimeTypes()
The list of secondary MIME types.



String
getShortDescription()
A short description of the app.



Boolean
getSupportsCreate()
Whether this app supports creating objects.



Boolean
getSupportsImport()
Whether this app supports importing from Google Docs.



Boolean
getSupportsMultiOpen()
Whether this app supports opening more than one file.



Boolean
getSupportsOfflineCreate()
Whether this app supports creating files when offline.



Boolean
getUseByDefault()
Whether the app is selected as the default handler for the types it supports.



App
set(String fieldName,
   Object value) 


App
setAuthorized(Boolean authorized)
Whether the app is authorized to access data on the user's Drive.



App
setCreateInFolderTemplate(String createInFolderTemplate)
The template URL to create a file with this app in a given folder.



App
setCreateUrl(String createUrl)
The URL to create a file with this app.



App
setHasDriveWideScope(Boolean hasDriveWideScope)
Whether the app has Drive-wide scope.



App
setIcons(List<AppIcons> icons)
The various icons for the app.



App
setId(String id)
The ID of the app.



App
setInstalled(Boolean installed)
Whether the app is installed.



App
setKind(String kind)
Output only.



App
setLongDescription(String longDescription)
A long description of the app.



App
setName(String name)
The name of the app.



App
setObjectType(String objectType)
The type of object this app creates such as a Chart.



App
setOpenUrlTemplate(String openUrlTemplate)
The template URL for opening files with this app.



App
setPrimaryFileExtensions(List<String> primaryFileExtensions)
The list of primary file extensions.



App
setPrimaryMimeTypes(List<String> primaryMimeTypes)
The list of primary MIME types.



App
setProductId(String productId)
The ID of the product listing for this app.



App
setProductUrl(String productUrl)
A link to the product listing for this app.



App
setSecondaryFileExtensions(List<String> secondaryFileExtensions)
The list of secondary file extensions.



App
setSecondaryMimeTypes(List<String> secondaryMimeTypes)
The list of secondary MIME types.



App
setShortDescription(String shortDescription)
A short description of the app.



App
setSupportsCreate(Boolean supportsCreate)
Whether this app supports creating objects.



App
setSupportsImport(Boolean supportsImport)
Whether this app supports importing from Google Docs.



App
setSupportsMultiOpen(Boolean supportsMultiOpen)
Whether this app supports opening more than one file.



App
setSupportsOfflineCreate(Boolean supportsOfflineCreate)
Whether this app supports creating files when offline.



App
setUseByDefault(Boolean useByDefault)
Whether the app is selected as the default handler for the types it supports.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





App
public App()









Method Detail





getAuthorized
public Boolean getAuthorized()
Whether the app is authorized to access data on the user's Drive.

Returns:
value or null for none








setAuthorized
public App setAuthorized(Boolean authorized)
Whether the app is authorized to access data on the user's Drive.

Parameters:
authorized - authorized or null for none








getCreateInFolderTemplate
public String getCreateInFolderTemplate()
The template URL to create a file with this app in a given folder. The template contains the
 {folderId} to be replaced by the folder ID house the new file.

Returns:
value or null for none








setCreateInFolderTemplate
public App setCreateInFolderTemplate(String createInFolderTemplate)
The template URL to create a file with this app in a given folder. The template contains the
 {folderId} to be replaced by the folder ID house the new file.

Parameters:
createInFolderTemplate - createInFolderTemplate or null for none








getCreateUrl
public String getCreateUrl()
The URL to create a file with this app.

Returns:
value or null for none








setCreateUrl
public App setCreateUrl(String createUrl)
The URL to create a file with this app.

Parameters:
createUrl - createUrl or null for none








getHasDriveWideScope
public Boolean getHasDriveWideScope()
Whether the app has Drive-wide scope. An app with Drive-wide scope can access all files in the
 user's Drive.

Returns:
value or null for none








setHasDriveWideScope
public App setHasDriveWideScope(Boolean hasDriveWideScope)
Whether the app has Drive-wide scope. An app with Drive-wide scope can access all files in the
 user's Drive.

Parameters:
hasDriveWideScope - hasDriveWideScope or null for none








getIcons
public List<AppIcons> getIcons()
The various icons for the app.

Returns:
value or null for none








setIcons
public App setIcons(List<AppIcons> icons)
The various icons for the app.

Parameters:
icons - icons or null for none








getId
public String getId()
The ID of the app.

Returns:
value or null for none








setId
public App setId(String id)
The ID of the app.

Parameters:
id - id or null for none








getInstalled
public Boolean getInstalled()
Whether the app is installed.

Returns:
value or null for none








setInstalled
public App setInstalled(Boolean installed)
Whether the app is installed.

Parameters:
installed - installed or null for none








getKind
public String getKind()
Output only. Identifies what kind of resource this is. Value: the fixed string "drive#app".

Returns:
value or null for none








setKind
public App setKind(String kind)
Output only. Identifies what kind of resource this is. Value: the fixed string "drive#app".

Parameters:
kind - kind or null for none








getLongDescription
public String getLongDescription()
A long description of the app.

Returns:
value or null for none








setLongDescription
public App setLongDescription(String longDescription)
A long description of the app.

Parameters:
longDescription - longDescription or null for none








getName
public String getName()
The name of the app.

Returns:
value or null for none








setName
public App setName(String name)
The name of the app.

Parameters:
name - name or null for none








getObjectType
public String getObjectType()
The type of object this app creates such as a Chart. If empty, the app name should be used
 instead.

Returns:
value or null for none








setObjectType
public App setObjectType(String objectType)
The type of object this app creates such as a Chart. If empty, the app name should be used
 instead.

Parameters:
objectType - objectType or null for none








getOpenUrlTemplate
public String getOpenUrlTemplate()
The template URL for opening files with this app. The template contains {ids} or {exportIds} to
 be replaced by the actual file IDs. For more information, see Open Files for the full
 documentation.

Returns:
value or null for none








setOpenUrlTemplate
public App setOpenUrlTemplate(String openUrlTemplate)
The template URL for opening files with this app. The template contains {ids} or {exportIds} to
 be replaced by the actual file IDs. For more information, see Open Files for the full
 documentation.

Parameters:
openUrlTemplate - openUrlTemplate or null for none








getPrimaryFileExtensions
public List<String> getPrimaryFileExtensions()
The list of primary file extensions.

Returns:
value or null for none








setPrimaryFileExtensions
public App setPrimaryFileExtensions(List<String> primaryFileExtensions)
The list of primary file extensions.

Parameters:
primaryFileExtensions - primaryFileExtensions or null for none








getPrimaryMimeTypes
public List<String> getPrimaryMimeTypes()
The list of primary MIME types.

Returns:
value or null for none








setPrimaryMimeTypes
public App setPrimaryMimeTypes(List<String> primaryMimeTypes)
The list of primary MIME types.

Parameters:
primaryMimeTypes - primaryMimeTypes or null for none








getProductId
public String getProductId()
The ID of the product listing for this app.

Returns:
value or null for none








setProductId
public App setProductId(String productId)
The ID of the product listing for this app.

Parameters:
productId - productId or null for none








getProductUrl
public String getProductUrl()
A link to the product listing for this app.

Returns:
value or null for none








setProductUrl
public App setProductUrl(String productUrl)
A link to the product listing for this app.

Parameters:
productUrl - productUrl or null for none








getSecondaryFileExtensions
public List<String> getSecondaryFileExtensions()
The list of secondary file extensions.

Returns:
value or null for none








setSecondaryFileExtensions
public App setSecondaryFileExtensions(List<String> secondaryFileExtensions)
The list of secondary file extensions.

Parameters:
secondaryFileExtensions - secondaryFileExtensions or null for none








getSecondaryMimeTypes
public List<String> getSecondaryMimeTypes()
The list of secondary MIME types.

Returns:
value or null for none








setSecondaryMimeTypes
public App setSecondaryMimeTypes(List<String> secondaryMimeTypes)
The list of secondary MIME types.

Parameters:
secondaryMimeTypes - secondaryMimeTypes or null for none








getShortDescription
public String getShortDescription()
A short description of the app.

Returns:
value or null for none








setShortDescription
public App setShortDescription(String shortDescription)
A short description of the app.

Parameters:
shortDescription - shortDescription or null for none








getSupportsCreate
public Boolean getSupportsCreate()
Whether this app supports creating objects.

Returns:
value or null for none








setSupportsCreate
public App setSupportsCreate(Boolean supportsCreate)
Whether this app supports creating objects.

Parameters:
supportsCreate - supportsCreate or null for none








getSupportsImport
public Boolean getSupportsImport()
Whether this app supports importing from Google Docs.

Returns:
value or null for none








setSupportsImport
public App setSupportsImport(Boolean supportsImport)
Whether this app supports importing from Google Docs.

Parameters:
supportsImport - supportsImport or null for none








getSupportsMultiOpen
public Boolean getSupportsMultiOpen()
Whether this app supports opening more than one file.

Returns:
value or null for none








setSupportsMultiOpen
public App setSupportsMultiOpen(Boolean supportsMultiOpen)
Whether this app supports opening more than one file.

Parameters:
supportsMultiOpen - supportsMultiOpen or null for none








getSupportsOfflineCreate
public Boolean getSupportsOfflineCreate()
Whether this app supports creating files when offline.

Returns:
value or null for none








setSupportsOfflineCreate
public App setSupportsOfflineCreate(Boolean supportsOfflineCreate)
Whether this app supports creating files when offline.

Parameters:
supportsOfflineCreate - supportsOfflineCreate or null for none








getUseByDefault
public Boolean getUseByDefault()
Whether the app is selected as the default handler for the types it supports.

Returns:
value or null for none








setUseByDefault
public App setUseByDefault(Boolean useByDefault)
Whether the app is selected as the default handler for the types it supports.

Parameters:
useByDefault - useByDefault or null for none








set
public App set(String fieldName,
               Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public App clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`App`	`clone()`
`Boolean`	`getAuthorized()` Whether the app is authorized to access data on the user's Drive.
`String`	`getCreateInFolderTemplate()` The template URL to create a file with this app in a given folder.
`String`	`getCreateUrl()` The URL to create a file with this app.
`Boolean`	`getHasDriveWideScope()` Whether the app has Drive-wide scope.
`List<AppIcons>`	`getIcons()` The various icons for the app.
`String`	`getId()` The ID of the app.
`Boolean`	`getInstalled()` Whether the app is installed.
`String`	`getKind()` Output only.
`String`	`getLongDescription()` A long description of the app.
`String`	`getName()` The name of the app.
`String`	`getObjectType()` The type of object this app creates such as a Chart.
`String`	`getOpenUrlTemplate()` The template URL for opening files with this app.
`List<String>`	`getPrimaryFileExtensions()` The list of primary file extensions.
`List<String>`	`getPrimaryMimeTypes()` The list of primary MIME types.
`String`	`getProductId()` The ID of the product listing for this app.
`String`	`getProductUrl()` A link to the product listing for this app.
`List<String>`	`getSecondaryFileExtensions()` The list of secondary file extensions.
`List<String>`	`getSecondaryMimeTypes()` The list of secondary MIME types.
`String`	`getShortDescription()` A short description of the app.
`Boolean`	`getSupportsCreate()` Whether this app supports creating objects.
`Boolean`	`getSupportsImport()` Whether this app supports importing from Google Docs.
`Boolean`	`getSupportsMultiOpen()` Whether this app supports opening more than one file.
`Boolean`	`getSupportsOfflineCreate()` Whether this app supports creating files when offline.
`Boolean`	`getUseByDefault()` Whether the app is selected as the default handler for the types it supports.
`App`	`set(String fieldName, Object value)`
`App`	`setAuthorized(Boolean authorized)` Whether the app is authorized to access data on the user's Drive.
`App`	`setCreateInFolderTemplate(String createInFolderTemplate)` The template URL to create a file with this app in a given folder.
`App`	`setCreateUrl(String createUrl)` The URL to create a file with this app.
`App`	`setHasDriveWideScope(Boolean hasDriveWideScope)` Whether the app has Drive-wide scope.
`App`	`setIcons(List<AppIcons> icons)` The various icons for the app.
`App`	`setId(String id)` The ID of the app.
`App`	`setInstalled(Boolean installed)` Whether the app is installed.
`App`	`setKind(String kind)` Output only.
`App`	`setLongDescription(String longDescription)` A long description of the app.
`App`	`setName(String name)` The name of the app.
`App`	`setObjectType(String objectType)` The type of object this app creates such as a Chart.
`App`	`setOpenUrlTemplate(String openUrlTemplate)` The template URL for opening files with this app.
`App`	`setPrimaryFileExtensions(List<String> primaryFileExtensions)` The list of primary file extensions.
`App`	`setPrimaryMimeTypes(List<String> primaryMimeTypes)` The list of primary MIME types.
`App`	`setProductId(String productId)` The ID of the product listing for this app.
`App`	`setProductUrl(String productUrl)` A link to the product listing for this app.
`App`	`setSecondaryFileExtensions(List<String> secondaryFileExtensions)` The list of secondary file extensions.
`App`	`setSecondaryMimeTypes(List<String> secondaryMimeTypes)` The list of secondary MIME types.
`App`	`setShortDescription(String shortDescription)` A short description of the app.
`App`	`setSupportsCreate(Boolean supportsCreate)` Whether this app supports creating objects.
`App`	`setSupportsImport(Boolean supportsImport)` Whether this app supports importing from Google Docs.
`App`	`setSupportsMultiOpen(Boolean supportsMultiOpen)` Whether this app supports opening more than one file.
`App`	`setSupportsOfflineCreate(Boolean supportsOfflineCreate)` Whether this app supports creating files when offline.
`App`	`setUseByDefault(Boolean useByDefault)` Whether the app is selected as the default handler for the types it supports.