fmewebservices.FMEOAuthV2WebService

`FMEOAuthV2WebService.clientSecretRequired`()	Returns true if the service requires a client secret.
`FMEOAuthV2WebService.getAuthorizationURL`()	Retrieves the associated authorization URL for this Web Service.
`FMEOAuthV2WebService.getClientID`()	Retrieves the associated client ID for this Web Service.
`FMEOAuthV2WebService.getClientSecret`()	Retrieves the associated client secret for this Web Service.
`FMEOAuthV2WebService.getDescription`()	Retrieves the optional description of this Web Service.
`FMEOAuthV2WebService.getHelpURL`()	Retrieves the optional help url of this Web Service.
`FMEOAuthV2WebService.getName`()	Retrieves the unique name of this Web Service.
`FMEOAuthV2WebService.getRedirectURI`()	Retrieves the associated redirect URI for this Web Service.
`FMEOAuthV2WebService.getSourceWebServiceName`()	Gets the source name for the original Web Service for the derived Web Services.
`FMEOAuthV2WebService.getTokenRefreshRequestFormat`()	Sets the token request format for refreshing access/refresh tokens for the Web Service.
`FMEOAuthV2WebService.getTokenRefreshURL`()	Retrieves the URL called to refresh the token for this Web Service.
`FMEOAuthV2WebService.isDerivedWebService`()	Returns `True` if the Web Service is derived from another source.
`FMEOAuthV2WebService.isInstalledWebService`()	Returns `True` if the Web Service is an installed Web Service.
`FMEOAuthV2WebService.setAuthorizationURL`(...)	Sets the authorization URL associated with this Web Service.
`FMEOAuthV2WebService.setClientID`(clientID)	Sets the client ID associated with this Web Service.
`FMEOAuthV2WebService.setClientSecret`(...)	Sets the client secret associated with this Web Service.
`FMEOAuthV2WebService.setClientSecretRequired`(...)	Sets whether the service requires a client secret.
`FMEOAuthV2WebService.setDescription`(description)	Sets the optional description of this Web Service.
`FMEOAuthV2WebService.setHelpURL`(url)	Sets the optional help url of this Web Service.
`FMEOAuthV2WebService.setName`(name)	Sets the unique name of this Web Service.
`FMEOAuthV2WebService.setRedirectURI`(redirectURI)	Sets the redirect URI associated with this Web Service.
`FMEOAuthV2WebService.setSourceWebServiceName`(name)	Sets the source name for the original Web Service for the derived Web Services.
`FMEOAuthV2WebService.setSupportHeaderAuthorization`(...)	Sets whether the service supports bearer tokens in the HTTP header.
`FMEOAuthV2WebService.setSupportQueryStringAuthorization`(...)	Sets whether the service supports access token strings in the URL.
`FMEOAuthV2WebService.setTokenRefreshRequestFormat`(...)	Sets the format for the POST call to refresh the token associated with this Web Service.
`FMEOAuthV2WebService.setTokenRefreshURL`(url)	Sets the URL called to refresh the access/refresh tokens.
`FMEOAuthV2WebService.supportHeaderAuthorization`()	Returns true if the service supports bearer tokens in the HTTP header.
`FMEOAuthV2WebService.supportQueryStringAuthorization`()	Returns true if the service supports access token strings in the URL.

class FMEOAuthV2WebService

FME OAuth Web Service class.

init()

Create an instance of an oauth Web Service object.

__init__(*args, **kwargs)

clientSecretRequired()

Returns true if the service requires a client secret.

Return type:: bool
Returns:: Whether the service requires a client secret.

getAuthorizationURL()

Retrieves the associated authorization URL for this Web Service.

Return type:: str
Returns:: The authorization URL.

getClientID()

Retrieves the associated client ID for this Web Service.

Return type:: str
Returns:: The client ID.

getClientSecret()

Retrieves the associated client secret for this Web Service.

Return type:: str
Returns:: The client secret.

getDescription()

Retrieves the optional description of this Web Service.

Return type:: str
Returns:: The description of the Web Service.

getHelpURL()

Retrieves the optional help url of this Web Service.

Return type:: str
Returns:: The url of the Web Service.

getName()

Retrieves the unique name of this Web Service.

Return type:: str
Returns:: The name of the Web Service.

getRedirectURI()

Retrieves the associated redirect URI for this Web Service.

Return type:: str
Returns:: The redirect URI.

getSourceWebServiceName()

Gets the source name for the original Web Service for the derived Web Services.

Return type:: str
Returns:: The source web service name.

getTokenRefreshRequestFormat()

Sets the token request format for refreshing access/refresh tokens for the Web Service.

Return type:: str
Returns:: The access token request format.

getTokenRefreshURL()

Retrieves the URL called to refresh the token for this Web Service.

Return type:: str
Returns:: The access token URL.

isDerivedWebService()

Returns True if the Web Service is derived from another source.

Return type:: bool
Returns:: Whether or not the Web Service is derived from another source.

isInstalledWebService()

Returns True if the Web Service is an installed Web Service.

Return type:: bool
Returns:: Whether or not the Web Service is an installed Web Service.

setAuthorizationURL(authorizationURL)

Sets the authorization URL associated with this Web Service.

Parameters:: authorizationURL (str) – The authorization URL.
Return type:: None

setClientID(clientID)

Sets the client ID associated with this Web Service.

Parameters:: clientID (str) – The client ID.
Return type:: None

setClientSecret(clientSecret)

Sets the client secret associated with this Web Service.

Parameters:: clientSecret (str) – The client secret.
Return type:: None

setClientSecretRequired(required)

Sets whether the service requires a client secret.

Parameters:: required (bool) – Whether the service requires a client secret.
Return type:: None

setDescription(description)

Sets the optional description of this Web Service.

Parameters:: description (str) – The description to set on the Web Service.
Return type:: None

setHelpURL(url)

Sets the optional help url of this Web Service.

Parameters:: url (str) – The url to set on the Web Service.
Return type:: None

setName(name)

Sets the unique name of this Web Service.

Parameters:: name (str) – The name to set on the Web Service.
Return type:: None

setRedirectURI(redirectURI)

Sets the redirect URI associated with this Web Service.

Parameters:: redirectURI (str) – The redirect URI.
Return type:: None

setSourceWebServiceName(name)

Sets the source name for the original Web Service for the derived Web Services.

Parameters:: name (str) – The source name to set for the original Web Service for the derived Web Services.
Return type:: None

setSupportHeaderAuthorization(supported)

Sets whether the service supports bearer tokens in the HTTP header.

Parameters:: supported (bool) – Whether the service supports bearer tokens.
Return type:: None

setSupportQueryStringAuthorization(supported)

Sets whether the service supports access token strings in the URL.

Parameters:: supported (bool) – Whether the service supports access token strings.
Return type:: None

setTokenRefreshRequestFormat(setTokenRefreshRequestFormat)

Sets the format for the POST call to refresh the token associated with this Web Service.

Parameters:: accessTokenRequestFormat (str) – The access token request format.
Return type:: None

setTokenRefreshURL(url)

Sets the URL called to refresh the access/refresh tokens.

Parameters:: accessTokenURL (str) – The access token URL.
Return type:: None

supportHeaderAuthorization()

Returns true if the service supports bearer tokens in the HTTP header.

Return type:: bool
Returns:: Whether the service supports bearer tokens.

supportQueryStringAuthorization()

Returns true if the service supports access token strings in the URL.

Return type:: bool
Returns:: Whether the service supports access token strings.