Class adobeDPS-ProfileImageService
- Extends:
- adobeDPS-ProfileImageService -> adobeDPS-Service -> adobeDPS-Class
- Platforms:
- iOS
ProfileImage service allows the storage of a profile image for each web overlay in the article.
Each web overlay can create its own profile image and get it whenever it need via javascript.
The single image is persisted for each web overlay in an article and subsequent launches of the application
Accessible from adobeDPS.profileImageService
Constructor
[inner]
Create an instance of the ProfileImageService.
Static Fields
Field | Defined By | |
---|---|---|
adobeDPS-ProfileImageService.adobeDPS-ProfileImageError
The Error codes that are called in the error callback.
|
ProfileImageService
|
|
adobeDPS-ProfileImageService.instance
The singleton of the ProfileImageService.
|
ProfileImageService
|
Methods
Method | Defined By | |
---|---|---|
getImage(successCallback:Function, errorCallback:Function)
This API will get the currently saved profile image.
|
ProfileImageService
|
|
setImage(imagePath:String, successCallback:Function, errorCallback:Function)
This API will set the profile image for the current web overlay.
|
ProfileImageService
|
|
toString()
Gets the string representation of this instance.
|
Class Detail
adobeDPS-ProfileImageService()
[inner]
Create an instance of the ProfileImageService.
- This is an internal constructor and shouldn't be called by regular users.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-ProfileImageService.adobeDPS-ProfileImageError
The Error codes that are called in the error callback.
The following are the error codes that are supported
NOSAVEDIMAGE, INVALIDURL
Value | Description |
---|---|
NOSAVEDIMAGE | No profile Image was set |
INVALIDURL | Url provided to setImage is invalid |
- Platforms:
- iOS
adobeDPS-ProfileImageService.instance
The singleton of the ProfileImageService.
- Platforms:
- iOS
Method Details
getImage(successCallback:Function, errorCallback:Function)
This API will get the currently saved profile image.
Parameters | ||
---|---|---|
successCallback | Function |
The callback function that handles the location data
when operation succeeds. Callback Signature: successHandler(imagePath) |
errorCallback | Function |
The callback function that handles the error when
operation fails. Callback Signature: errorHandler(errorCode, errorMessage) |
- Platforms:
- iOS
setImage(imagePath:String, successCallback:Function, errorCallback:Function)
This API will set the profile image for the current web overlay.
Parameters | ||
---|---|---|
imagePath | String | The path to the image that need to be set as the profile Image. Currently we support only local file paths. Relative Paths to the images are also Accepted. The Image Path from the camera API is accepted as is. |
successCallback | Function |
The callback function that handles the location data
when operation succeeds. The imagePath is not the same as the one provided as input
Callback Signature: successHandler(imagePath) |
errorCallback | Function |
The callback function that handles the error when
operation fails. Callback Signature: errorHandler(errorCode, errorMessage) |
- Platforms:
- iOS
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)