com.adobe.cq.socialmedia

Interface SocialApplication

public interface SocialApplication

Defines a Social Media application.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the application name
java.lang.String	getPostLink(SocialPostLinkParams params) Returns the link to the SM network for an individual post.
SocialPublisher	getPublisher() Returns a publisher with no token associated.
java.lang.String	setUpApp(java.lang.String appId, java.lang.String appToken, java.lang.String hostname, SocialAction socialAction) Sets up the SM application.

Method Detail

setUpApp

java.lang.String setUpApp(java.lang.String appId,
                          java.lang.String appToken,
                          java.lang.String hostname,
                          SocialAction socialAction)
                   throws SocialException

Sets up the SM application.

Parameters:

appId - Application ID

appToken - Application Secret

hostname - Web application hostname (ex.: https://localhost:4502)

socialAction - Action executed after OAuth

Returns:

OAuth URL

Throws:

SocialException - Thrown if the login URL cannot be built.

getName

java.lang.String getName()

Returns the application name

Returns:

Social application name (ex.: facebook)

getPostLink

java.lang.String getPostLink(SocialPostLinkParams params)
                      throws SocialException

Returns the link to the SM network for an individual post.

Parameters:

params - containing: spaceId - Page/Board where the post exists postId - the ID of the post

Returns:

Link to the SM network

Throws:

SocialException - Thrown if the social media URL cannot be built.

getPublisher

SocialPublisher getPublisher()

Returns a publisher with no token associated. It can be used if a token is already owned, by setting the token and calling publisher methods after.

Returns:

A social publisher which can be used if the API user already owns a token.