com.files.models

Class App

java.lang.Object

com.files.models.App

All Implemented Interfaces:

ModelInterface

public class App
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	appType The type of the App
Map<String,String>	documentationLinks Collection of named links to documentation
String	extendedDescription Long description for the in-App landing page
String	extendedDescriptionForMarketingSite Long form description of the App
String	externalHomepageUrl Link to external homepage
Boolean	featured Is featured on the App listing?
String	folderBehaviorType Associated Folder Behavior type, if any
String	iconUrl App icon
String	logoThumbnailUrl Logo thumbnail for the App
String	logoUrl Full size logo for the App
String	marketingIntro Marketing introdution of the App
String	marketingYoutubeUrl Marketing video page
String	name Name of the App
String	packageManagerInstallCommand Package manager install command
String	remoteServerType Associated Remote Server type, if any
String[]	screenshotListUrls Screenshots of the App
String	sdkInstallationInstructionsLink Link to SDK installation instructions
String	shortDescription Short description of the App
String	siemType Associated SIEM type, if any
String	ssoStrategyType Associated SSO Strategy type, if any
String	tutorialYoutubeUrl Tutorial video page

Constructor Summary

Constructors

Constructor and Description
App()
App(HashMap<String,Object> parameters)
App(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<App>	all()
static ListIterator<App>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<App>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<App>	list(HashMap<String,Object> parameters)
static ListIterator<App>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

appType

public String appType

The type of the App

documentationLinks

public Map<String,String> documentationLinks

Collection of named links to documentation

extendedDescription

public String extendedDescription

Long description for the in-App landing page

extendedDescriptionForMarketingSite

public String extendedDescriptionForMarketingSite

Long form description of the App

externalHomepageUrl

public String externalHomepageUrl

Link to external homepage

featured

public Boolean featured

Is featured on the App listing?

folderBehaviorType

public String folderBehaviorType

Associated Folder Behavior type, if any

iconUrl

public String iconUrl

App icon

logoThumbnailUrl

public String logoThumbnailUrl

Logo thumbnail for the App

logoUrl

public String logoUrl

Full size logo for the App

marketingIntro

public String marketingIntro

Marketing introdution of the App

marketingYoutubeUrl

public String marketingYoutubeUrl

Marketing video page

name

public String name

Name of the App

packageManagerInstallCommand

public String packageManagerInstallCommand

Package manager install command

remoteServerType

public String remoteServerType

Associated Remote Server type, if any

screenshotListUrls

public String[] screenshotListUrls

Screenshots of the App

sdkInstallationInstructionsLink

public String sdkInstallationInstructionsLink

Link to SDK installation instructions

shortDescription

public String shortDescription

Short description of the App

ssoStrategyType

public String ssoStrategyType

Associated SSO Strategy type, if any

siemType

public String siemType

Associated SIEM type, if any

tutorialYoutubeUrl

public String tutorialYoutubeUrl

Tutorial video page

Constructor Detail

App

public App()

App

public App(HashMap<String,Object> parameters)

App

public App(HashMap<String,Object> parameters,
           HashMap<String,Object> options)

Method Detail

list

public static ListIterator<App> list()
                              throws RuntimeException

Parameters: cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name` and `app_type`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.

Throws:

RuntimeException

list

public static ListIterator<App> list(HashMap<String,Object> parameters)
                              throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<App> list(HashMap<String,Object> parameters,
                                     HashMap<String,Object> options)
                              throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<App> all()
                             throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<App> all(HashMap<String,Object> parameters,
                                    HashMap<String,Object> options)
                             throws RuntimeException

Throws:

RuntimeException