org.openintents.intents
Class WikitudeARIntent

java.lang.Object
  extended by android.content.Intent
      extended by org.openintents.intents.WikitudeARIntent
All Implemented Interfaces:
android.os.Parcelable

public class WikitudeARIntent
extends android.content.Intent

This class represents the intent which has to be called from an external acitvity to launch the Wikitude AR Camera View. It contains all necessary methods to communicate with the API.

Version:
1.0.0-beta1
Author:
Martin Lechner, martin.lechner@mobilizy.com, www.mobilizy.com

Nested Class Summary
 
Nested classes/interfaces inherited from class android.content.Intent
android.content.Intent.FilterComparison, android.content.Intent.ShortcutIconResource
 
Nested classes/interfaces inherited from interface android.os.Parcelable
android.os.Parcelable.Creator<T>
 
Field Summary
 
Fields inherited from class android.content.Intent
ACTION_AIRPLANE_MODE_CHANGED, ACTION_ALL_APPS, ACTION_ANSWER, ACTION_ATTACH_DATA, ACTION_BATTERY_CHANGED, ACTION_BATTERY_LOW, ACTION_BOOT_COMPLETED, ACTION_BUG_REPORT, ACTION_CALL, ACTION_CALL_BUTTON, ACTION_CAMERA_BUTTON, ACTION_CHOOSER, ACTION_CLOSE_SYSTEM_DIALOGS, ACTION_CONFIGURATION_CHANGED, ACTION_CREATE_SHORTCUT, ACTION_DATE_CHANGED, ACTION_DEFAULT, ACTION_DELETE, ACTION_DEVICE_STORAGE_LOW, ACTION_DEVICE_STORAGE_OK, ACTION_DIAL, ACTION_EDIT, ACTION_FACTORY_TEST, ACTION_GET_CONTENT, ACTION_GTALK_SERVICE_CONNECTED, ACTION_GTALK_SERVICE_DISCONNECTED, ACTION_HEADSET_PLUG, ACTION_INPUT_METHOD_CHANGED, ACTION_INSERT, ACTION_INSERT_OR_EDIT, ACTION_MAIN, ACTION_MANAGE_PACKAGE_STORAGE, ACTION_MEDIA_BAD_REMOVAL, ACTION_MEDIA_BUTTON, ACTION_MEDIA_CHECKING, ACTION_MEDIA_EJECT, ACTION_MEDIA_MOUNTED, ACTION_MEDIA_NOFS, ACTION_MEDIA_REMOVED, ACTION_MEDIA_SCANNER_FINISHED, ACTION_MEDIA_SCANNER_SCAN_FILE, ACTION_MEDIA_SCANNER_STARTED, ACTION_MEDIA_SHARED, ACTION_MEDIA_UNMOUNTABLE, ACTION_MEDIA_UNMOUNTED, ACTION_NEW_OUTGOING_CALL, ACTION_PACKAGE_ADDED, ACTION_PACKAGE_CHANGED, ACTION_PACKAGE_DATA_CLEARED, ACTION_PACKAGE_INSTALL, ACTION_PACKAGE_REMOVED, ACTION_PACKAGE_REPLACED, ACTION_PACKAGE_RESTARTED, ACTION_PICK, ACTION_PICK_ACTIVITY, ACTION_PROVIDER_CHANGED, ACTION_REBOOT, ACTION_RUN, ACTION_SCREEN_OFF, ACTION_SCREEN_ON, ACTION_SEARCH, ACTION_SEARCH_LONG_PRESS, ACTION_SEND, ACTION_SENDTO, ACTION_SET_WALLPAPER, ACTION_SYNC, ACTION_SYSTEM_TUTORIAL, ACTION_TIME_CHANGED, ACTION_TIME_TICK, ACTION_TIMEZONE_CHANGED, ACTION_UID_REMOVED, ACTION_UMS_CONNECTED, ACTION_UMS_DISCONNECTED, ACTION_USER_PRESENT, ACTION_VIEW, ACTION_VOICE_COMMAND, ACTION_WALLPAPER_CHANGED, ACTION_WEB_SEARCH, CATEGORY_ALTERNATIVE, CATEGORY_BROWSABLE, CATEGORY_DEFAULT, CATEGORY_DEVELOPMENT_PREFERENCE, CATEGORY_EMBED, CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST, CATEGORY_HOME, CATEGORY_INFO, CATEGORY_LAUNCHER, CATEGORY_MONKEY, CATEGORY_OPENABLE, CATEGORY_PREFERENCE, CATEGORY_SAMPLE_CODE, CATEGORY_SELECTED_ALTERNATIVE, CATEGORY_TAB, CATEGORY_TEST, CATEGORY_UNIT_TEST, CREATOR, EXTRA_ALARM_COUNT, EXTRA_BCC, EXTRA_CC, EXTRA_DATA_REMOVED, EXTRA_DONT_KILL_APP, EXTRA_EMAIL, EXTRA_INTENT, EXTRA_KEY_EVENT, EXTRA_PHONE_NUMBER, EXTRA_REPLACING, EXTRA_SHORTCUT_ICON, EXTRA_SHORTCUT_ICON_RESOURCE, EXTRA_SHORTCUT_INTENT, EXTRA_SHORTCUT_NAME, EXTRA_STREAM, EXTRA_SUBJECT, EXTRA_TEMPLATE, EXTRA_TEXT, EXTRA_TITLE, EXTRA_UID, FILL_IN_ACTION, FILL_IN_CATEGORIES, FILL_IN_COMPONENT, FILL_IN_DATA, FLAG_ACTIVITY_BROUGHT_TO_FRONT, FLAG_ACTIVITY_CLEAR_TOP, FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS, FLAG_ACTIVITY_FORWARD_RESULT, FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY, FLAG_ACTIVITY_MULTIPLE_TASK, FLAG_ACTIVITY_NEW_TASK, FLAG_ACTIVITY_NO_HISTORY, FLAG_ACTIVITY_NO_USER_ACTION, FLAG_ACTIVITY_PREVIOUS_IS_TOP, FLAG_ACTIVITY_REORDER_TO_FRONT, FLAG_ACTIVITY_RESET_TASK_IF_NEEDED, FLAG_ACTIVITY_SINGLE_TOP, FLAG_DEBUG_LOG_RESOLUTION, FLAG_FROM_BACKGROUND, FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION, FLAG_RECEIVER_REGISTERED_ONLY
 
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
 
Constructor Summary
WikitudeARIntent(android.app.Application application, java.lang.String applicationKey, java.lang.String developerName)
          default constructor of the WikitudeARIntent
 
Method Summary
 boolean addPOI(WikitudePOI poi)
          Add a POI to the AR camera view.
 boolean addPOIs(java.util.Collection<WikitudePOI> pois)
          Adds all given POIs to the list of displayed POIs.
 void addTitleImageResource(java.lang.String imageresource)
          Adds a given image-title to the intent via a Resource name.
 void addTitleImageUri(java.lang.String imageUri)
          Adds a given image-title to the intent via a URI.
 void addTitleText(java.lang.String title)
          Adds a given text-title to the intent.
 WikitudePOI getPOI(int position)
          Returns the POI at the given position.
 java.util.ArrayList<WikitudePOI> getPOIs()
          Returns the list of all POIs in the view.
 int getPOIsSize()
          Returns the number of POIs to be displayed in the view.
static android.app.Dialog handleWikitudeNotFound(android.app.Activity activity)
          The method creates the dialog which notifies the user that Wikitude is not installed on the system (default messages are used).
static android.app.Dialog handleWikitudeNotFound(android.app.Activity activity, java.lang.String dialogTitle, java.lang.String dialogText)
          The method creates the dialog which notifies the user that Wikitude is not installed on the system.
 WikitudePOI removePOI(int position)
          Removes the POI at the given position in the list from the view.
 boolean removePOI(WikitudePOI poi)
          Remove a POI from the view.
 
Methods inherited from class android.content.Intent
addCategory, addFlags, clone, cloneFilter, createChooser, describeContents, fillIn, filterEquals, filterHashCode, getAction, getBooleanArrayExtra, getBooleanExtra, getBundleExtra, getByteArrayExtra, getByteExtra, getCategories, getCharArrayExtra, getCharExtra, getCharSequenceExtra, getComponent, getData, getDataString, getDoubleArrayExtra, getDoubleExtra, getExtras, getFlags, getFloatArrayExtra, getFloatExtra, getIntArrayExtra, getIntegerArrayListExtra, getIntent, getIntentOld, getIntExtra, getLongArrayExtra, getLongExtra, getParcelableArrayExtra, getParcelableArrayListExtra, getParcelableExtra, getScheme, getSerializableExtra, getShortArrayExtra, getShortExtra, getStringArrayExtra, getStringArrayListExtra, getStringExtra, getType, hasCategory, hasExtra, hasFileDescriptors, parseIntent, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtra, putExtras, putExtras, putIntegerArrayListExtra, putParcelableArrayListExtra, putStringArrayListExtra, readFromParcel, removeCategory, removeExtra, replaceExtras, replaceExtras, resolveActivity, resolveActivityInfo, resolveType, resolveType, resolveTypeIfNeeded, setAction, setClass, setClassName, setClassName, setComponent, setData, setDataAndType, setExtrasClassLoader, setFlags, setType, toString, toURI, writeToParcel
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WikitudeARIntent

public WikitudeARIntent(android.app.Application application,
                        java.lang.String applicationKey,
                        java.lang.String developerName)
default constructor of the WikitudeARIntent

Parameters:
application - the application which launches the intent
applicationKey - the application key received from the registration process. Use null to use the API in the beta-mode.
developerName - the developer's name given during the registration process.
Method Detail

addPOI

public boolean addPOI(WikitudePOI poi)
Add a POI to the AR camera view.

Parameters:
poi - The point of interest to be added.
Returns:
true if adding the POI was successful, false if not.

addPOIs

public boolean addPOIs(java.util.Collection<WikitudePOI> pois)
Adds all given POIs to the list of displayed POIs.

Parameters:
pois - The POIs to be added.
Returns:
true if adding was successful, false if not

removePOI

public boolean removePOI(WikitudePOI poi)
Remove a POI from the view.

Parameters:
poi - The point of interest to be removed.
Returns:
true if removing the POI was successful, false if not

removePOI

public WikitudePOI removePOI(int position)
Removes the POI at the given position in the list from the view.

Parameters:
position - The position of the POI in the list to be removed.
Returns:
the POI which was removed

getPOIsSize

public int getPOIsSize()
Returns the number of POIs to be displayed in the view.

Returns:
the number of POIs to be displayed in the view

getPOI

public WikitudePOI getPOI(int position)
Returns the POI at the given position.

Parameters:
position - the position of the POI
Returns:
the POI at the given position

getPOIs

public java.util.ArrayList<WikitudePOI> getPOIs()
Returns the list of all POIs in the view.

Returns:
the list of all POIs in the view

addTitleText

public void addTitleText(java.lang.String title)
Adds a given text-title to the intent.

Parameters:
title - the title

addTitleImageResource

public void addTitleImageResource(java.lang.String imageresource)
Adds a given image-title to the intent via a Resource name.

Parameters:
imageresource - the resourcename of the image (determined by activity.getResources().getResourceName(R.[...]))

addTitleImageUri

public void addTitleImageUri(java.lang.String imageUri)
Adds a given image-title to the intent via a URI.

Parameters:
imageUri - the uri of the image

handleWikitudeNotFound

public static android.app.Dialog handleWikitudeNotFound(android.app.Activity activity,
                                                        java.lang.String dialogTitle,
                                                        java.lang.String dialogText)
The method creates the dialog which notifies the user that Wikitude is not installed on the system.

Parameters:
activity - the activity which should display the dialog.
dialogTitle - the title of the dialog box
dialogText - the text in the dialog box
Returns:
the dialog

handleWikitudeNotFound

public static android.app.Dialog handleWikitudeNotFound(android.app.Activity activity)
The method creates the dialog which notifies the user that Wikitude is not installed on the system (default messages are used).

Parameters:
activity - the activity which should display the dialog.
Returns:
the dialog