com.adobe.cq.social.commons.annotation

Annotation Type Endpoint

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface Endpoint

This annotation is used to declare a social component endpoint.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description This is generally used as a description for the object described by the meta type.
java.lang.String	example Example of the endpoint syntax.
java.lang.String	name Defines the Endpoint name.
java.lang.String	resourceType Defines the resource type that this endpoint providing service.

Element Detail

name

public abstract java.lang.String name

Defines the Endpoint name.

Returns:

String

Default:

""

resourceType

public abstract java.lang.String resourceType

Defines the resource type that this endpoint providing service.

Returns:

String

Default:

""

description

public abstract java.lang.String description

This is generally used as a description for the object described by the meta type.

Returns:

String

Default:

""

example

public abstract java.lang.String example

Example of the endpoint syntax.

Returns:

String

Default:

""