diff --git a/docs/client/com.mytiki.publish.client.capture.rsp/-block-rsp/-block-rsp.html b/docs/client/com.mytiki.publish.client.capture.rsp/-block-rsp/-block-rsp.html new file mode 100644 index 0000000..ded8d1e --- /dev/null +++ b/docs/client/com.mytiki.publish.client.capture.rsp/-block-rsp/-block-rsp.html @@ -0,0 +1,72 @@ + + +
+ +Service class for capturing and processing receipt data.
Service class for capturing and processing receipt data.
Publishes an - emailAttachment based on its type.
Publishes an array of - emailAttachments.
Publishes an emailAttachment based on its type.
Publishes an array of attachments.
Publishes an emailAttachment based on its type.
-This function publishes an emailAttachment. It offerUses the provided Context - instance, a string pointer, and an Attachment object. The function calls the appropriate publish - method based on the type of the emailAttachment (IMAGE, PDF, TEXT).
A CompletableDeferred object that will be completed when the emailAttachment has been published.
-The Context instance. This is typically the - current activity or application context from which this function is called. It - is used to provide context for the publishing process.
The Attachment object containing the details - of the emailAttachment to be published.
Publishes an array of emailAttachments.
-This function publishes an array of emailAttachments. It offerUses the provided - Context instance, a string pointer, and an array of Attachment objects. The function calls the - publish method for each emailAttachment in the array.
A CompletableDeferred object that will be completed when all the emailAttachments have been published.
-The Context instance. This is typically the - current activity or application context from which this function is called. It - is used to provide context for the publishing process.
The array of Attachment objects containing - the details of the emailAttachments to be published.
Publishes an emailAttachment based on its type.
This function publishes an emailAttachment. It offerUses the provided Context instance, a string pointer, and an EmailAttachment object. The function calls the appropriate publish method based on the type of the emailAttachment (IMAGE, PDF, TEXT).
A CompletableDeferred object that will be completed when the emailAttachment has been published.
The Context instance. This is typically the current activity or application context from which this function is called. It is used to provide context for the publishing process.
The EmailAttachment object containing the details of the emailAttachment to be published.
Publishes an array of attachments.
This function publishes an array of attachments. It offerUses the provided Context instance, a string pointer, and an array of EmailAttachment objects. The function calls the publish method for each attachment in the array.
A CompletableDeferred object that will be completed when all the attachments have been published.
The Context instance. This is typically the current activity or application context from which this function is called. It is used to provide context for the publishing process.
The array of EmailAttachment objects containing the details of the attachments to be published.
Retrieve the structured data extracted from the processed receipt images.
This method fetches the result of the receipt image processing from the server.
The unique identifier for the receipt obtained from the publish method.
The address token to connect with TIKI API.
A callback functions that revceives the array of CaptureReceiptRsp objects, each containing the structured data extracted from an image of the receipt, or null if the retrieval fails.
Retrieve the structured data extracted from the processed receipt images.
This method fetches the result of the receipt image processing from the server.
The unique identifier for the receipt obtained from the publish method.
The address token to connect with TIKI API.
A callback functions that revceives the array of CaptureReceiptRsp objects, each containing the structured data extracted from an image of the receipt, or null if the retrieval fails.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Email provider enum
Email provider enum
Returns the enum constant - of this type with the specified name. The string must match - exactly an identifier used to declare an enum constant in this - type. (Extraneous whitespace characters are not permitted.)
-Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing - the constants of this enum type, in the order they're - declared.
Returns an array containing the constants of this enum type, in the order they're declared.
Scrapes emails in chunks for processing.
A CompletableDeferred indicating whether further scraping is required.
-The context.
The email account.
The number of items to process in each - chunk.
Scrapes emails in chunks for processing.
A CompletableDeferred indicating whether further scraping is required.
The context.
The email account.
The number of items to process in each chunk.
Initiates the process of scraping emails for receipts.
A CompletableDeferred indicating the completion of the scraping process.
-The context.
The email account.
The client ID.
Initiates the process of scraping emails for receipts.
A CompletableDeferred indicating the completion of the scraping process.
The context.
The email account.
The client ID.
Service for managing email-related operations such as authentication, - retrieval, and processing.
Service for managing email-related operations such as authentication, retrieval, and processing.
Retrieves the list of - connected email accounts for the specified provider.
Retrieves the list of connected email accounts for the specified provider.
Initiates the process of - scraping emails for receipts.
Initiates the process of scraping emails for receipts.
Scrapes emails in chunks - for processing.
Scrapes emails in chunks for processing.
Retrieves the email - response after authentication.
Retrieves the email response after authentication.
Retrieves the list of - messages for the specified email account.
Retrieves the list of messages for the specified email account.
Email provider enum
-Email provider enum
Service for managing - email-related operations such as authentication, retrieval, and - processing.
Service for managing email-related operations such as authentication, retrieval, and processing.
OptInService class for managing opt-in operations.
This class provides methods to show an offer and settings to the user. It maintains the state of the current offer and offer list. It also keeps track of the initial navigation route.
Shows an offer to the user.
This method starts the OptInActivity and sets the initial navigation route based on the permissions of the offer. If the user is not authorized for a permission, the initial route is set to PERMISSIONS. Otherwise, it is set to OFFERS. The offer is then shown to the user.
The Context instance. This is typically the current activity or application context from which this method is called. It is used to start the OptInActivity.
The Offer object containing the details of the offer to be shown.
Shows the settings to the user.
This method starts the OptInActivity and sets the initial navigation route to SETTINGS. The settings, which include a list of offers, are then shown to the user.
The Context instance. This is typically the current activity or application context from which this method is called. It is used to start the OptInActivity.
The list of Offer objects to be shown in the settings.
OptInService class for managing opt-in operations.
Tiki Client Library
-The TIKI APIs comprise a set of HTTP REST APIs designed for seamless - integration with any standard HTTP client. The Client Libraries serve as a user-friendly - layer around the TIKI APIs, introducing methods for common operations such as authorization, - licensing, capture, card-linked offers, and offerRewards. It is a collection of pre-existing - code with minimal dependencies, offering a streamlined integration process with TIKI Rest - APIs, which reduces the amount of code necessary for integration.
-TikiClient is the top-level entry point for of the TIKI Client Library. It - offers simple methods that calls the underlying libraries to perform common operations. - Programmers can use it to simplify the integration process or opt for individual libraries - based on their specific needs.
Tiki Client Library
The TIKI APIs comprise a set of HTTP REST APIs designed for seamless integration with any standard HTTP client. The Client Libraries serve as a user-friendly layer around the TIKI APIs, introducing methods for common operations such as authorization, licensing, capture, card-linked offers, and offerRewards. It is a collection of pre-existing code with minimal dependencies, offering a streamlined integration process with TIKI Rest APIs, which reduces the amount of code necessary for integration.
TikiClient is the top-level entry point for of the TIKI Client Library. It offers simple methods that calls the underlying libraries to perform common operations. Programmers can use it to simplify the integration process or opt for individual libraries based on their specific needs.
Accepts an offer.
Accepts an offer.
Initiates the process of - creating a license.
Initiates the process of creating a license.
Declines an offer.
-Declines an offer.
Configures the email keys - for the TikiClient.
Configures the email keys for the TikiClient.
Initializes the TikiClient - with the provided user ID.
Initializes the TikiClient with the provided user ID.
Checks if a specific - permission is authorized.
Checks if a specific permission is authorized.
Initiates the login process for a user.
Requests the specified - permissions.
Requests the specified permissions.
Publishes an array of emailAttachments for receipt data extraction.
Retrieve the structured data extracted from the processed receipt image.
Initiates the process of - revoking a license.
Initiates the process of revoking a license.
Initiates the process of - scanning a physical receipt and returns the receipt ID.
-Initiates the process of scanning a physical receipt and returns the receipt ID.
AuthService instance for - handling authentication.
AuthService instance for handling authentication.
CaptureService instance for - handling receipt capture.
CaptureService instance for handling receipt capture.
EmailService instance for - handling email operations.
EmailService instance for handling email operations.
LicenseService instance for - managing licensing.
LicenseService instance for managing licensing.
OfferService instance for - managing offers.
OfferService instance for managing offers.
OptInService instance for - managing opt-in operations.
Publishes an array of emailAttachments for receipt data extraction.
-This function publishes an array of emailAttachments for receipt data - extraction. The provided emailAttachments are sent to the capture service for processing. The - function is asynchronous and returns a CompletableDeferred object that will be completed when - the data has been published.
A CompletableDeferred object that will be completed when the data has been published.
-The Context instance. This is typically the - current activity or application context from which this function is called. It - is used to provide context for the publishing process.
The array of Attachment objects to be - published.
Publishes an array of emailAttachments for receipt data extraction.
This function publishes an array of emailAttachments for receipt data extraction. The provided emailAttachments are sent to the capture service for processing. The function is asynchronous and returns a CompletableDeferred object that will be completed when the data has been published.
A CompletableDeferred object that will be completed when the data has been published.
The Context instance. This is typically the current activity or application context from which this function is called. It is used to provide context for the publishing process.
The array of EmailAttachment objects to be published.
Retrieve the structured data extracted from the processed receipt image.
This method fetches the result of the receipt image processing from the server.
The unique identifier for the receipt obtained from the publish method.
A callback functions that receives the array of CaptureReceiptRsp objects, each containing the structured data extracted from an image of the receipt, or null if the retrieval fails.
Retrieve the structured data extracted from the processed receipt image.
This method fetches the result of the receipt image processing from the server.
The unique identifier for the receipt obtained from the publish method.
A callback functions that receives the array of CaptureReceiptRsp objects, each containing the structured data extracted from an image of the receipt, or null if the retrieval fails.
This function is used to display a specific offer to the user.
This is typically the current activity or application context from which this function is called.
The Offer object containing the details of the offer to be shown.
A callback function that will be called with the result of the offer display process. The result is a map where the keys are the displayed offers and the values are Booleans indicating whether each offer was accepted.
if the client is not configured or the user ID is not set.
This function is used to display the settings to the user.
This is typically the current activity or application context from which this function is called.
The list of Offer objects to be shown in the settings.
A callback function that will be called with the result of the settings display process. The result is a map where the keys are the displayed offers and the values are Booleans indicating whether each offer was accepted.
if the client is not configured or the user ID is not set.