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
String	description This is generally used as a description for the object described by the meta type.
String	example Example of the endpoint syntax.
String	name Defines the Endpoint name.
String	resourceType Defines the resource type that this endpoint providing service.

Element Detail

name

public abstract String name

Defines the Endpoint name.

Default:

""

resourceType

public abstract String resourceType

Defines the resource type that this endpoint providing service.

Default:

""

description

public abstract String description

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

Default:

""

example

public abstract String example

Example of the endpoint syntax.

Default:

""