|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Observable
proximiant.sdk.api.ProximiantClientApi
public class ProximiantClientApi
Proximiant Client API for accessing Receipts DATA Most our API are using the Async approach, when ready we will send notification to observers for API result.
Field Summary | |
---|---|
static java.lang.String |
ADS
|
static java.lang.String |
API_FAILURE
|
static java.lang.String |
CAMERA_RECEIPT
|
static java.lang.String |
CREATE_CHAT
|
static java.lang.String |
CREATE_GROUP
|
static java.lang.String |
CREATE_USER_LOYALTY_CARD
|
static java.lang.String |
DELETE_RECEIPT
|
static java.lang.String |
DELETE_RECEIPT_FROM_GROUP
|
static java.lang.String |
DELETE_USER_GROUP
|
static java.lang.String |
DELETE_USER_LOYALTY_CARD
|
static java.lang.String |
DEV
|
static java.lang.String |
FRANCHISE_CHAT_HISTORY
|
static java.lang.String |
GET_CAMERA_RECEIPT
|
static java.lang.String |
GET_RECEIPT_HTML
|
static java.lang.String |
GROUP
|
static java.lang.String |
GROUP_RECEIPT_LIST
|
static java.lang.String |
LOYALTY
|
static java.lang.String |
NOTIFICATION
|
static java.lang.String |
OFFLINE_RECEIPT
|
static java.lang.String |
PROD
|
static java.lang.String |
PRODUCT_CHAT_HISTORY
|
static java.lang.String |
PROX_ACCESS_TOKEN
|
static java.lang.String |
RECEIPT_CHAT_HISTORY
|
static java.lang.String |
RECEIPT_DETAIL
|
static java.lang.String |
RECEIPT_LIST
|
static java.lang.String |
RECEIPT_PRODUCT_CHAT_HISTORY
|
static java.lang.String |
REG_GCM
|
static java.lang.String |
REG_RECEIPT
|
static java.lang.String |
STAGE
|
static java.lang.String |
STORE_CHAT_HISTORY
|
static java.lang.String |
STORES
|
static java.lang.String |
SUGGESTED_LOYALTY_CARD
|
static java.lang.String |
USER_LOYALTY_CARD
|
static java.lang.String |
USER_PROFILE
|
Constructor Summary | |
---|---|
ProximiantClientApi()
|
|
ProximiantClientApi(java.lang.String env)
|
Method Summary | |
---|---|
void |
addNewImageChat(int idPost,
android.graphics.Bitmap bmp)
|
void |
addNewTextChat(int idPost,
java.lang.String text)
|
void |
addReceiptToUserProject(java.lang.String publicId,
java.lang.String rid)
|
java.lang.String |
b64EncodeBitmap(android.graphics.Bitmap bmp)
|
java.lang.String |
b64EncodeString(java.lang.String text)
|
void |
cameraReceipt(android.graphics.Bitmap bmp,
java.lang.Float total,
java.lang.Float subTotal,
int storeId,
java.lang.String description,
java.lang.String rid)
|
void |
checkProxAuth(android.content.Context context,
java.lang.String cId,
java.lang.String secret)
|
void |
clearReceiptsCache(int page)
|
void |
createUserLoyaltyCard(java.lang.String publicId,
java.lang.String businessName,
int businessId,
java.lang.String barcode,
java.lang.String barcodeType)
|
void |
createUserProject(java.lang.String publicId,
java.lang.String name,
java.lang.String colorCode,
java.lang.String description)
|
java.lang.String |
decodeB64String(java.lang.String b64String)
|
void |
deleteReceipt(java.lang.String rid)
|
void |
deleteReceiptFromUserProject(java.lang.String publicId,
java.lang.String rid)
|
void |
deleteUserProject(java.lang.String publicId)
|
void |
delUserLoyaltyCard(java.lang.String publicId)
|
java.lang.String |
generateLocalRid()
|
android.graphics.Bitmap |
generatePhotoThumbnail(android.graphics.Bitmap bmp)
|
void |
getAccessTokenByFacebookToken(java.lang.String fbToken,
java.lang.String clientId)
|
void |
getAccessTokenByRefreshToken(java.lang.String refreshToken,
java.lang.String clientId,
java.lang.String clientSecret)
|
void |
getAds(java.lang.String rid)
|
java.lang.String |
getApiHost()
|
void |
getCameraReceiptImage(java.lang.String rid)
|
void |
getChatHistoryForFranchise(int idFranchise)
|
void |
getChatHistoryForProduct(int idProduct)
|
void |
getChatHistoryForReceipt(java.lang.String rid)
|
void |
getChatHistoryForReceiptProduct(java.lang.String rid,
int idProduct)
|
void |
getChatHistoryForStore(int idStore)
|
void |
getLoyaltyProgram(int programId)
Calls a get for loyalty program of the given id. |
void |
getLoyaltyPrograms()
Calls a get for all loyalty programs for the access code |
ProximiantApiResult |
getOfflinePendingReceipts(android.content.Context context)
|
static java.lang.String |
getRandUUID()
|
void |
getReceiptByRid(java.lang.String rid)
|
void |
getReceiptHtml(java.lang.String rid)
|
void |
getReceipts(int page)
|
void |
getReceiptsForUserProject(java.lang.String publicId,
int page)
Calls get for receipts associated to the user project id |
void |
getStores()
Get Stores associated with the Client. |
void |
getSuggestedLoyaltyCards()
Check all user's receipt and return possible User Loyalty card for franchises. |
void |
getUserLoyaltyCards()
Getter api to get a list of Loyalty card for current user. |
void |
getUserProfile()
User profile information |
void |
getUserProjectDetail(java.lang.String publicId)
|
void |
getUserProjects()
Return a list of groups for user. |
void |
logout()
|
void |
registerGcmId(java.lang.String gcmId)
|
void |
registerReceipt(java.lang.String rid)
|
void |
searchReceipts(java.lang.String query,
int page)
|
void |
setAccessCode(java.lang.String accessCode)
|
void |
setCacheExpire(android.content.Context context,
java.lang.Integer value)
|
void |
updateUserProject(java.lang.String publicId,
java.lang.String name,
java.lang.String colorCode,
java.lang.String description)
|
java.lang.String |
urlEncode(java.lang.String value)
|
Methods inherited from class java.util.Observable |
---|
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PROD
public static final java.lang.String STAGE
public static final java.lang.String DEV
public static final java.lang.String PROX_ACCESS_TOKEN
public static final java.lang.String API_FAILURE
public static final java.lang.String RECEIPT_LIST
public static final java.lang.String GROUP_RECEIPT_LIST
public static final java.lang.String RECEIPT_DETAIL
public static final java.lang.String REG_RECEIPT
public static final java.lang.String DELETE_RECEIPT
public static final java.lang.String ADS
public static final java.lang.String USER_PROFILE
public static final java.lang.String LOYALTY
public static final java.lang.String SUGGESTED_LOYALTY_CARD
public static final java.lang.String USER_LOYALTY_CARD
public static final java.lang.String CREATE_USER_LOYALTY_CARD
public static final java.lang.String DELETE_USER_LOYALTY_CARD
public static final java.lang.String NOTIFICATION
public static final java.lang.String REG_GCM
public static final java.lang.String CAMERA_RECEIPT
public static final java.lang.String GET_CAMERA_RECEIPT
public static final java.lang.String GET_RECEIPT_HTML
public static final java.lang.String STORES
public static final java.lang.String FRANCHISE_CHAT_HISTORY
public static final java.lang.String STORE_CHAT_HISTORY
public static final java.lang.String PRODUCT_CHAT_HISTORY
public static final java.lang.String RECEIPT_CHAT_HISTORY
public static final java.lang.String RECEIPT_PRODUCT_CHAT_HISTORY
public static final java.lang.String GROUP
public static final java.lang.String CREATE_GROUP
public static final java.lang.String DELETE_USER_GROUP
public static final java.lang.String DELETE_RECEIPT_FROM_GROUP
public static final java.lang.String CREATE_CHAT
public static final java.lang.String OFFLINE_RECEIPT
Constructor Detail |
---|
public ProximiantClientApi()
public ProximiantClientApi(java.lang.String env)
Method Detail |
---|
public static java.lang.String getRandUUID()
public java.lang.String generateLocalRid()
public void setCacheExpire(android.content.Context context, java.lang.Integer value)
context
- Activity content, required to get the Cache foldervalue
- expire time in seconds.public java.lang.String getApiHost()
public void setAccessCode(java.lang.String accessCode)
accessCode
- oAuth2 access code for a logged in user.public void getAds(java.lang.String rid)
rid
- get related ads for a given receipt id.public void getUserProfile()
public void getStores()
public void getReceiptHtml(java.lang.String rid)
public void getCameraReceiptImage(java.lang.String rid)
rid
- Receipt IDpublic void cameraReceipt(android.graphics.Bitmap bmp, java.lang.Float total, java.lang.Float subTotal, int storeId, java.lang.String description, java.lang.String rid)
bmp
- Bitmap of a camera result to be registered as a new receipt.total
- Total amount of this receipt from user inputsubTotal
- Sub total of this receipt from user inputstoreId
- Store ID associated with this receipt from user input.description
- Some text for this receipt.rid
- a new string generated by the generateLocalRid() api.public void getLoyaltyProgram(int programId)
programId
- public void getLoyaltyPrograms()
public void getSuggestedLoyaltyCards()
public void getUserLoyaltyCards()
public void createUserLoyaltyCard(java.lang.String publicId, java.lang.String businessName, int businessId, java.lang.String barcode, java.lang.String barcodeType)
publicId
- a random UUID to represent this new loyalty cards.businessName
- name from getSuggestedLoyaltyCardsbusinessId
- id from getSuggestedLoyaltyCardsbarcode
- barcode of the user loyalty cardbarcodeType
- barcode type, expected value is listed below:
CODE39, CODE128, QRCODE, UPCA, UPCE, EAN8, EAN13, PDF417, ISBN10, ISBN13
Additional note:
businessId can be 0, we will create a new type from businessName instead of look up a matching business name.public void delUserLoyaltyCard(java.lang.String publicId)
publicId
- id of user loyalty card from getUserLoyaltyCards callpublic void getUserProjects()
public void getUserProjectDetail(java.lang.String publicId)
publicId
- group ID returned from getUserProjectspublic void createUserProject(java.lang.String publicId, java.lang.String name, java.lang.String colorCode, java.lang.String description)
publicId
- a unique random UUID to represent group.name
- Name of the groupcolorCode
- Color Code for the group (possible value from http://www.w3schools.com/html/html_colornames.asp)description
- detail description of the groups.public void updateUserProject(java.lang.String publicId, java.lang.String name, java.lang.String colorCode, java.lang.String description)
publicId
- group ID returned from getUserProjectsname
- New group name.colorCode
- New Color Codedescription
- New Description.public void deleteUserProject(java.lang.String publicId)
publicId
- group ID returned from getUserProjectspublic void addReceiptToUserProject(java.lang.String publicId, java.lang.String rid)
publicId
- group ID returned from getUserProjectsrid
- rid of the receipt.
This API will associate receipt with the group.public void deleteReceiptFromUserProject(java.lang.String publicId, java.lang.String rid)
publicId
- group ID returned from getUserProjectsrid
- rid of the receipt.
This API will remove one receipt from the group.public void getChatHistoryForFranchise(int idFranchise)
idFranchise
- if of a Franchise.public void getChatHistoryForStore(int idStore)
idStore
- id of the Store.public void getChatHistoryForProduct(int idProduct)
idProduct
- Product IDpublic void getChatHistoryForReceipt(java.lang.String rid)
rid
- Receipt RIDpublic void getChatHistoryForReceiptProduct(java.lang.String rid, int idProduct)
rid
- Receipt RIDidProduct
- Product ID
Get the chat history for a production within a receipt contextpublic void addNewTextChat(int idPost, java.lang.String text)
idPost
- POST ID from above getChatHistory calltext
- text value of the new chat content.public void addNewImageChat(int idPost, android.graphics.Bitmap bmp)
idPost
- POST ID from above getChatHistory callbmp
- Bitmap of the new chat contentpublic void clearReceiptsCache(int page)
page
- page number of the receipts list, we will evict cache result for this page.public ProximiantApiResult getOfflinePendingReceipts(android.content.Context context)
context
- required to store info on persistent storage.
Will return ProximiantApiResult to represent a list of pending
picture receipts stored locally.
once a picture receipt is registered online, it will be removed
from this local persistent store, and calling this function again will
not include those receipts.public void getReceipts(int page)
page
- page number to retrieve desired receipts list, start from 1.public void getReceiptsForUserProject(java.lang.String publicId, int page)
publicId
- user project Idpage
- page number to retrieve desired receipts listpublic void getReceiptByRid(java.lang.String rid)
rid
- receipt idpublic void deleteReceipt(java.lang.String rid)
rid
- receipt idpublic void registerReceipt(java.lang.String rid)
rid
- receipt idpublic void registerGcmId(java.lang.String gcmId)
gcmId
- google cloud message regist id for current device.public void searchReceipts(java.lang.String query, int page)
query
- text query to search receiptpage
- offset of the searchpublic java.lang.String decodeB64String(java.lang.String b64String)
b64String
- String in Base 64 format
public java.lang.String b64EncodeString(java.lang.String text)
text
- to be encoded
public java.lang.String b64EncodeBitmap(android.graphics.Bitmap bmp)
bmp
- Bitmap to be encoded.
public android.graphics.Bitmap generatePhotoThumbnail(android.graphics.Bitmap bmp)
bmp
- Bitmap to work on.
public java.lang.String urlEncode(java.lang.String value)
value
- Text to be url encoded.
public void logout()
public void checkProxAuth(android.content.Context context, java.lang.String cId, java.lang.String secret)
context
- Activity contextcId
- Client ID we distribute to the client/developer.secret
- Client Secret we distribute to the client/developer.public void getAccessTokenByRefreshToken(java.lang.String refreshToken, java.lang.String clientId, java.lang.String clientSecret)
refreshToken
- Refresh Token from last Access Token request.clientId
- Client ID Proximiant distributed.clientSecret
- Client Secret Proximiant distributed.public void getAccessTokenByFacebookToken(java.lang.String fbToken, java.lang.String clientId)
fbToken
- Facebook Access Token from Facebook SDKclientId
- Client ID Proximiant distributed to client/developer.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |