ru.appsm.inapphelp.logic

Class IAHGear

java.lang.Object

ru.appsm.inapphelp.logic.IAHGear

Direct Known Subclasses:

IAHInapphelpGear

public abstract class IAHGear
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
IAHGear()

Method Summary

Modifier and Type	Method and Description
void	addReplyOnATicket(java.lang.String cancelTag, java.lang.String message, java.util.Map[] deviceInfo, IAHUploadAttachment[] attachments, java.lang.String pushToken, java.lang.Long get_updates_from_time, IAHUser user, RequestQueue queue, OnFetchedArraySuccessListener success, ErrorListener errorListener)
boolean	canIgnoreTicketUpdateInformationAfterAddingReply()
boolean	canUplaodMessageAsHtmlString() returns if gear can upload message as html string.
void	createNewTicket(java.lang.String cancelTag, java.lang.String pushToken, IAHUser user, java.lang.String body, java.lang.String deviceInfo, IAHUploadAttachment[] attachments, RequestQueue queue, OnNewTicketFetchedSuccessListener successListener, ErrorListener errorListener) HSUploadAttachment.getAttachment() can contain mime/Type and filename
void	fetchKBArticle(java.lang.String cancelTag, IAHKBItem section, RequestQueue queue, OnFetchedArraySuccessListener success, ErrorListener errorListener)
void	fetchUpdateOnTicket(java.lang.String cancelTag, java.lang.Long get_updates_from_time, IAHUser user, RequestQueue queue, OnFetchedArraySuccessListener success, ErrorListener errorListener)
java.lang.String	getCompanySupportEmailAddress()
int	getLocalArticleResourceId()
int	getNumberOfAttachmentGearCanHandle()
java.lang.String	getRefer()
boolean	haveImplementedKBFetching() Returns if gear have implemented KB Fetching.
boolean	haveImplementedTicketFetching() Returns if gear have implemented Ticket Fetching.
void	ignoreTicketUpdateInformationAfterAddingReply(boolean canIgnore) if true, gear don't have to return back HSTicketUpdate object, after a reply is been added.
void	init()
void	registerNewUser(java.lang.String cancelTag, java.lang.String firstName, java.lang.String lastname, java.lang.String emailAddress, java.lang.String userId, java.lang.String userSecret, RequestQueue queue, OnFetchedSuccessListener success, ErrorListener errorListener)
void	setNotImplementingKBFetching(int articleResid) Set this parameter, if gear is not implementing handling of FAQ.
void	setNotImplementingTicketsFetching(java.lang.String companySupportEmailAddress) Set this parameter, if gear is not implementing handling of Issues.
void	setNumberOfAttachmentGearCanHandle(int numberOfAttachmentGearCanHandle) Sets maximum number of attachment gears can handle.
void	uploadMessageAsHtmlString(boolean htmlEnabled) If this parameter is set, message written by user in chat screen and new issue screen will be returned in HTML format.

Methods inherited from class java.lang.Object

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

Constructor Detail

IAHGear

public IAHGear()

Method Detail

init

public void init()

getRefer

public java.lang.String getRefer()

fetchKBArticle

public void fetchKBArticle(java.lang.String cancelTag,
                           IAHKBItem section,
                           RequestQueue queue,
                           OnFetchedArraySuccessListener success,
                           ErrorListener errorListener)

Parameters:

cancelTag -

section -

queue -

success -

errorListener -

registerNewUser

public void registerNewUser(java.lang.String cancelTag,
                            java.lang.String firstName,
                            java.lang.String lastname,
                            java.lang.String emailAddress,
                            java.lang.String userId,
                            java.lang.String userSecret,
                            RequestQueue queue,
                            OnFetchedSuccessListener success,
                            ErrorListener errorListener)

Parameters:

cancelTag -

firstName -

lastname -

emailAddress -

userId -

userSecret -

queue -

success -

errorListener -

createNewTicket

public void createNewTicket(java.lang.String cancelTag,
                            java.lang.String pushToken,
                            IAHUser user,
                            java.lang.String body,
                            java.lang.String deviceInfo,
                            IAHUploadAttachment[] attachments,
                            RequestQueue queue,
                            OnNewTicketFetchedSuccessListener successListener,
                            ErrorListener errorListener)

HSUploadAttachment.getAttachment() can contain mime/Type and filename

Parameters:

user -

body -

deviceInfo -

successListener -

errorListener -

fetchUpdateOnTicket

public void fetchUpdateOnTicket(java.lang.String cancelTag,
                                java.lang.Long get_updates_from_time,
                                IAHUser user,
                                RequestQueue queue,
                                OnFetchedArraySuccessListener success,
                                ErrorListener errorListener)

Parameters:

cancelTag -

get_updates_from_time -

user -

queue -

success -

errorListener -

addReplyOnATicket

public void addReplyOnATicket(java.lang.String cancelTag,
                              java.lang.String message,
                              java.util.Map[] deviceInfo,
                              IAHUploadAttachment[] attachments,
                              java.lang.String pushToken,
                              java.lang.Long get_updates_from_time,
                              IAHUser user,
                              RequestQueue queue,
                              OnFetchedArraySuccessListener success,
                              ErrorListener errorListener)

Parameters:

message -

deviceInfo -

user -

queue -

success -

errorListener -

setNotImplementingTicketsFetching

public void setNotImplementingTicketsFetching(java.lang.String companySupportEmailAddress)

Set this parameter, if gear is not implementing handling of Issues. Doing this, default email client will be open with given support Email Address. Then there is no need to implement issues fetching related methods.

Parameters:

companySupportEmailAddress -

getCompanySupportEmailAddress

public java.lang.String getCompanySupportEmailAddress()

Returns:

Company support email address set in setNotImplementingTicketsFetching

haveImplementedTicketFetching

public boolean haveImplementedTicketFetching()

Returns if gear have implemented Ticket Fetching. Modify this parameter using setNotImplementingTicketsFetching

Returns:

setNotImplementingKBFetching

public void setNotImplementingKBFetching(int articleResid)

Set this parameter, if gear is not implementing handling of FAQ. Doing this, FAQ will be fetched from article path. Then there is no need to implement issues fetching related methods.

Parameters:

articleResid -

getLocalArticleResourceId

public int getLocalArticleResourceId()

Returns:

Local article id set in setNotImplementingKBFetching

haveImplementedKBFetching

public boolean haveImplementedKBFetching()

Returns if gear have implemented KB Fetching. Modify this parameter using setNotImplementingKBFetching

Returns:

uploadMessageAsHtmlString

public void uploadMessageAsHtmlString(boolean htmlEnabled)

If this parameter is set, message written by user in chat screen and new issue screen will be returned in HTML format.

Parameters:

htmlEnabled -

canUplaodMessageAsHtmlString

public boolean canUplaodMessageAsHtmlString()

returns if gear can upload message as html string.

Returns:

setNumberOfAttachmentGearCanHandle

public void setNumberOfAttachmentGearCanHandle(int numberOfAttachmentGearCanHandle)

Sets maximum number of attachment gears can handle.

Parameters:

numberOfAttachmentGearCanHandle -

getNumberOfAttachmentGearCanHandle

public int getNumberOfAttachmentGearCanHandle()

Returns:

maximum number of attachment gear can handle.

ignoreTicketUpdateInformationAfterAddingReply

public void ignoreTicketUpdateInformationAfterAddingReply(boolean canIgnore)

if true, gear don't have to return back HSTicketUpdate object, after a reply is been added.

Parameters:

canIgnore -

canIgnoreTicketUpdateInformationAfterAddingReply

public boolean canIgnoreTicketUpdateInformationAfterAddingReply()

Returns:

if the HSTicketUpdate object, after a reply is added should be used in UI.