Module gg.xp.xivapi

Annotation Interface XivApiThis


@Retention(RUNTIME) public @interface XivApiThis
Indicates that instead of reading from a field, the current object itself should be used.

That is, if I have a method called "getFoo()", by default, it will look at './fields/Foo'. If this annotation is used, then it will instead deserialize '.'.

This annotation implies that all fields on this object should be retrieved, i.e. fields=* (or transient=*). At the top level, this can NOT be combined with fields that would require an annotation such as @raw or @lang, but this is possible within nested objects because you could request them separately.