org.alfresco.mobile.android.api.services

Interface ActivityStreamService

All Superinterfaces:

android.os.Parcelable, Service

All Known Implementing Classes:

AbstractActivityStreamService, CloudActivityStreamServiceImpl, OnPremiseActivityStreamServiceImpl, PublicAPIActivityStreamServiceImpl

public interface ActivityStreamService
extends Service

Alfresco provides support for a news/activity feed in the context of an enterprise generating and acting upon content.
Activities track a range of changes, updates, events, and actions, allowing users to be aware of details of the changes.

Author:

Jean Marie Pascal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
List<ActivityEntry>	getActivityStream() Allow currently logged in user to get their activity stream.
PagingResult<ActivityEntry>	getActivityStream(ListingContext listingContext) Allow currently logged in user to get their activity stream.
List<ActivityEntry>	getActivityStream(String personIdentifier) Allow to retrieve activities feed for a specific user.
PagingResult<ActivityEntry>	getActivityStream(String personIdentifier, ListingContext listingContext) Allow to retrieve activities feed for a specific user.
List<ActivityEntry>	getSiteActivityStream(String siteName) Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).
PagingResult<ActivityEntry>	getSiteActivityStream(String siteName, ListingContext listingContext) Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).

Methods inherited from interface org.alfresco.mobile.android.api.services.Service

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

getActivityStream

List<ActivityEntry> getActivityStream()

Allow currently logged in user to get their activity stream.

Returns:

Returns a list of activities for the current user. The result list can be empty list if there's no activity.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getActivityStream

PagingResult<ActivityEntry> getActivityStream(ListingContext listingContext)

Allow currently logged in user to get their activity stream.

Parameters:

listingContext - : define characteristics of result

Returns:

Returns a paged list of activities for the current user.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getActivityStream

List<ActivityEntry> getActivityStream(String personIdentifier)

Allow to retrieve activities feed for a specific user.

Parameters:

personIdentifier - : a specific user

Returns:

Returns a list of activities for the given user. The result list can be empty if there's no activity or personIdentifier doesn't exist.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getActivityStream

PagingResult<ActivityEntry> getActivityStream(String personIdentifier,
                                            ListingContext listingContext)

Allow to retrieve activities feed for a specific user.

Parameters:

personIdentifier - : a specific user

listingContext - : define characteristics of the paging result

Returns:

Returns a paged list of activities for the given user. The result list can be empty if there's no activity or personIdentifier doesn't exist.

Throws:

AlfrescoServiceException - : If username is undefined or if network or internal problems occur during the process.

getSiteActivityStream

List<ActivityEntry> getSiteActivityStream(String siteName)

Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).

Parameters:

siteName - : Share site short name

Returns:

Returns a list of activities for the current user and specified site. The result list can be empty if there's no activity or logged in user is not a member.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getSiteActivityStream

PagingResult<ActivityEntry> getSiteActivityStream(String siteName,
                                                ListingContext listingContext)

Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).

Parameters:

siteName - : Share site short name

listingContext - : define characteristics of result

Returns:

Returns a paged list of activities for the current user and specified site. The result list can be empty if there's no activity or logged in user is not a member.

Throws:

AlfrescoServiceException - : If siteName is undefined or if network or internal problems occur during the process.