Documentation
¶
Index ¶
- type AccountService
- type Album
- type Annotation
- type AnnotationsParams
- type AnnotationsService
- type ApiResponse
- type Artist
- type ArtistParams
- type ArtistsService
- type Author
- type Client
- type Hit
- type Media
- type Referent
- type ReferentsParams
- type ReferentsService
- type SearchParams
- type SearchService
- type Song
- type SongParams
- type SongRelationship
- type SongsService
- type User
- type WebPage
- type WebPagesService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountService ¶
type AccountService service
type Album ¶
type Album struct {
ApiPath string `json:"api_path,omitempty"`
CoverArtURL string `json:"cover_art_url,omitempty"`
FullTitle string `json:"full_title,omitempty"`
ID int `json:"id,omitempty"`
Name string `json:"name,omitempty"`
URL string `json:"url,omitempty"`
Artist *Artist `json:"artist,omitempty"`
}
type Annotation ¶
type Annotation struct {
ApiPath string `json:"api_path,omitempty"`
Body interface{} `json:"body,omitempty"`
CommentCount int `json:"comment_count,omitempty"`
Community bool `json:"community,omitempty"`
CustomPreview bool `json:"custom_preview,omitempty"`
HasVoters bool `json:"has_voters,omitempty"`
ID int `json:"id,omitempty"`
Pinned bool `json:"pinned,omitempty"`
Source string `json:"source,omitempty"`
State string `json:"state,omitempty"`
URL string `json:"url,omitempty"`
Verified bool `json:"verified,omitempty"`
VotesTotal int `json:"votes_total,omitempty"`
CurrentUserMetadata *struct {
Permissions []string `json:"permissions,omitempty"`
ExcludedPermissions []string `json:"excluded_permissions,omitempty"`
Interactions *struct {
Following bool `json:"following,omitempty"`
} `json:"interactions,omitempty"`
} `json:"current_user_metadata,omitempty"`
Authors []Author `json:"authors,omitempty"`
CosignedBy []interface{} `json:"cosigned_by,omitempty"`
RejectionComment string `json:"rejection_comment,omitempty"`
VerifiedBy *User `json:"verified_by,omitempty"`
Referent *Referent `json:"referent,omitempty"`
}
type AnnotationsParams ¶
type AnnotationsParams struct {
TextFormat string `url:"text_format,omitempty"`
}
type AnnotationsService ¶
type AnnotationsService service
func (*AnnotationsService) Get ¶
func (s *AnnotationsService) Get(ID string) (*Annotation, error)
type ApiResponse ¶
type ApiResponse struct {
Meta *struct {
Status int `json:"status,omitempty"`
} `json:"meta,omitempty"`
Response *struct {
Annotation *Annotation `json:"annotation,omitempty"`
Referents []Referent `json:"referents,omitempty"`
Song *Song `json:"song,omitempty"`
Artist *Artist `json:"artist,omitempty"`
Hits []Hit `json:"hits,omitempty"`
} `json:"response,omitempty"`
}
type Artist ¶
type Artist struct {
AlternateNames []string `json:"alternate_names,omitempty"`
ApiPath string `json:"api_path,omitempty"`
Description interface{} `json:"description,omitempty"`
FacebookName string `json:"facebook_name,omitempty"`
FollowersCount int `json:"followers_count,omitempty"`
HeaderImageURL string `json:"header_image_url,omitempty"`
ID string `json:"id,omitempty"`
ImageURL string `json:"image_url,omitempty"`
InstagramName string `json:"instagram_name,omitempty"`
IsMemeVerified bool `json:"is_meme_verified,omitempty"`
IsVerified bool `json:"is_verified,omitempty"`
Name string `json:"name,omitempty"`
TranslationArtist bool `json:"translation_artist,omitempty"`
TwitterName string `json:"twitter_name,omitempty"`
URL string `json:"url,omitempty"`
CurrentUserMetadata *struct {
Permissions []string `json:"permissions,omitempty"`
ExcludedPermissions []string `json:"excluded_permissions,omitempty"`
Interactions *struct {
Following bool `json:"following,omitempty"`
} `json:"interactions,omitempty"`
} `json:"current_user_metadata,omitempty"`
IQ int `json:"iq,omitempty"`
DescriptionAnnotation *struct {
Type string `json:"_type,omitempty"`
AnnotatorID int `json:"annotator_id,omitempty"`
AnnotatorLogin string `json:"annotator_login,omitempty"`
ApiPath string `json:"api_path,omitempty"`
Classification string `json:"classification,omitempty"`
Fragment string `json:"fragment,omitempty"`
ID int `json:"id,omitempty"`
IsDescription bool `json:"is_description,omitempty"`
Path string `json:"path,omitempty"`
Range *struct {
Content string `json:"content,omitempty"`
} `json:"range,omitempty"`
SongID int `json:"song_id,omitempty"`
URL string `json:"url,omitempty"`
VerifiedAnnotatorIDs []int `json:"verified_annotator_ids,omitempty"`
Annotatable *struct {
ApiPath string `json:"api_path,omitempty"`
Context string `json:"context,omitempty"`
ID int `json:"id,omitempty"`
ImageURL string `json:"image_url,omitempty"`
LinkTitle string `json:"link_title,omitempty"`
Title string `json:"title,omitempty"`
Type string `json:"type,omitempty"`
URL string `json:"url,omitempty"`
} `json:"annotatable,omitempty"`
Annotations []Annotation `json:"annotations,omitempty"`
} `json:"description_annotation,omitempty"`
User *User `json:"user,omitempty"`
}
type ArtistParams ¶
type ArtistParams struct {
TextFormat string `url:"text_format,omitempty"`
}
type ArtistsService ¶
type ArtistsService service
type Client ¶
type Client struct {
Account *AccountService
Annotations *AnnotationsService
Artists *ArtistsService
Referents *ReferentsService
Search *SearchService
Songs *SongsService
WebPages *WebPagesService
// contains filtered or unexported fields
}
type Hit ¶
type Hit struct {
HighLights interface{} `json:"highlights,omitempty"`
Index string `json:"string,omitempty"`
Type string `json:"type,omitempty"`
Result *struct {
AnnotationCount int `json:"annotation_count,omitempty"`
ApiPath string `json:"api_path,omitempty"`
FullTitle string `json:"full_title,omitempty"`
HeaderImageThumbnailURL string `json:"header_image_thumbnail_url,omitempty"`
ID int `json:"id,omitempty"`
LyricsOwnerID int `json:"lyrics_owner_id,omitempty"`
LyricsState string `json:"lyrics_state,omitempty"`
Path string `json:"path,omitempty"`
PyongsCount int `json:"pyongs_count,omitempty"`
SongArtImageThumbnailURL string `json:"song_art_image_thumbnail_url,omitempty"`
SongArtImageURL string `json:"song_art_image_url,omitempty"`
Stats *struct {
UnreviewedAnnotations int `json:"unreviewed_annotations,omitempty"`
Concurrents int `json:"concurrents,omitempty"`
Hot bool `json:"hot,omitempty"`
PageViews int `json:"page_views,omitempty"`
} `json:"stats,omitempty"`
Title string `json:"title,omitempty"`
TitleWithFeatured string `json:"title_with_featured,omitempty"`
URL string `json:"url,omitempty"`
PrimaryArtist *Artist `json:"primary_artist,omitempty"`
} `json:"result,omitempty"`
}
type Referent ¶
type Referent struct {
Type string `json:"_type,omitempty"`
AnnotatorID int `json:"annotator_id,omitempty"`
AnnotatorLogin string `json:"annotator_login,omitempty"`
ApiPath string `json:"api_path,omitempty"`
Classification string `json:"classification,omitempty"`
Featured bool `json:"featured,omitempty"`
Fragment string `json:"fragment,omitempty"`
ID int `json:"id,omitempty"`
IsDescription bool `json:"is_description,omitempty"`
Path string `json:"path,omitempty"`
Range *struct {
Start string `json:"start,omitempty"`
StartOffset string `json:"startOffset,omitempty"`
End string `json:"end,omitempty"`
EndOffset string `json:"endOffset,omitempty"`
Before string `json:"before,omitempty"`
After string `json:"after,omitempty"`
Content string `json:"content,omitempty"`
} `json:"range,omitempty"`
SongID int `json:"song_id,omitempty"`
URL string `json:"url,omitempty"`
VerifiedAnnotatorIDs []int `json:"verified_annotator_ids,omitempty"`
Annotatable *struct {
ApiPath string `json:"api_path,omitempty"`
Context string `json:"context,omitempty"`
ID int `json:"id,omitempty"`
ImageURL string `json:"image_url,omitempty"`
LinkTitle string `json:"link_title,omitempty"`
Title string `json:"title,omitempty"`
Type string `json:"type,omitempty"`
URL string `json:"url,omitempty"`
} `json:"annotatable,omitempty"`
Annotations []Annotation `json:"annotations,omitempty"`
}
type ReferentsParams ¶
type ReferentsService ¶
type ReferentsService service
func (*ReferentsService) GetBySongID ¶
func (s *ReferentsService) GetBySongID(ID int) ([]Referent, error)
func (*ReferentsService) GetByUserID ¶
func (s *ReferentsService) GetByUserID(ID int) ([]Referent, error)
func (*ReferentsService) GetByWebPageID ¶
func (s *ReferentsService) GetByWebPageID(ID int) ([]Referent, error)
type SearchParams ¶
type SearchParams struct {
Q string `url:"q,omitempty"`
}
type SearchService ¶
type SearchService service
type Song ¶
type Song struct {
AnnotationCount int `json:"annotation_count,omitempty"`
ApiPath string `json:"api_path,omitempty"`
AppleMusicID string `json:"apple_music_id,omitempty"`
AppleMusicPlayerURL string `json:"apple_music_player_url,omitempty"`
Description interface{} `json:"description,omitempty"`
EmbedContent string `json:"embed_content,omitempty"`
FeaturedVideo bool `json:"featured_video,omitempty"`
FullTitle string `json:"full_title,omitempty"`
HeaderImageThumbnailURL string `json:"header_image_thumbnail_url,omitempty"`
HeaderImageURL string `json:"header_image_url,omitempty"`
ID int `json:"id,omitempty"`
LyricsOwnerID int `json:"lyrics_owner_id,omitempty"`
LyricsState string `json:"lyrics_state,omitempty"`
Path string `json:"path,omitempty"`
PyongsCount int `json:"pyongs_count,omitempty"`
SongArtImageThumbnailURL string `json:"song_art_image_thumbnail_url,omitempty"`
SongArtImageURL string `json:"song_art_image_url,omitempty"`
Stats *struct {
UnreviewedAnnotations int `json:"unreviewed_annotations,omitempty"`
Concurrents int `json:"concurrents,omitempty"`
Hot bool `json:"hot,omitempty"`
PageViews int `json:"page_views,omitempty"`
} `json:"stats,omitempty"`
Title string `json:"title,omitempty"`
TitleFeatured string `json:"title_features,omitempty"`
URL string `json:"url,omitempty"`
CurrentUserMetadata *struct {
Permissions []string `json:"permissions,omitempty"`
ExcludedPermissions []string `json:"excluded_permissions,omitempty"`
Interactions *struct {
Following bool `json:"following,omitempty"`
} `json:"interactions,omitempty"`
} `json:"current_user_metadata,omitempty"`
Album *Album `json:"album,omitempty"`
CustomPerformances []interface{} `json:"cutom_performances,omitempty"`
DescriptionAnnotation *struct {
Type string `json:"_type,omitempty"`
AnnotatorID int `json:"annotator_id,omitempty"`
AnnotatorLogin string `json:"annotator_login,omitempty"`
ApiPath string `json:"api_path,omitempty"`
Classification string `json:"classification,omitempty"`
Fragment string `json:"fragment,omitempty"`
ID int `json:"id,omitempty"`
IsDescription bool `json:"is_description,omitempty"`
Path string `json:"path,omitempty"`
Range *struct {
Content string `json:"content,omitempty"`
} `json:"range,omitempty"`
SongID int `json:"song_id,omitempty"`
URL string `json:"url,omitempty"`
VerifiedAnnotatorIDs []int `json:"verified_annotator_ids,omitempty"`
Annotatable *struct {
ApiPath string `json:"api_path,omitempty"`
Context string `json:"context,omitempty"`
ID int `json:"id,omitempty"`
ImageURL string `json:"image_url,omitempty"`
LinkTitle string `json:"link_title,omitempty"`
Title string `json:"title,omitempty"`
Type string `json:"type,omitempty"`
URL string `json:"url,omitempty"`
} `json:"annotatable,omitempty"`
Annotations []Annotation `json:"annotations,omitempty"`
} `json:"description_annotation,omitempty"`
FeaturedArtists []interface{} `json:"featured_artists,omitempty"`
LyricsMarkedCompleteBy interface{} `json:"lyrics_marked_complete_by,omitempty"`
Media []Media `json:"media,omitempty"`
PrimaryArtist *Artist `json:"primary_artist,omitempty"`
ProducerArtists []Artist `json:"producer_artists,omitempty"`
SongRelationships []SongRelationship `json:"song_relationships,omitempty"`
VerifiedAnnotationsBy []interface{} `json:"verified_annotations_by,omitempty"`
VerifiedContributors []interface{} `json:"verified_contributors,omitempty"`
VerifiedLyricsBy []interface{} `json:"verified_lyrics_by,omitempty"`
WriterArtists []Artist `json:"writer_artists,omitempty"`
}
type SongParams ¶
type SongParams struct {
TextFormat string `url:"text_format,omitempty"`
}
type SongRelationship ¶
type SongsService ¶
type SongsService service
type User ¶
type User struct {
ApiPath string `json:"api_path,omitempty"`
Avatar *struct {
Tiny *struct {
URL string `json:"url,omitempty"`
BoundingBox *struct {
Width int `json:"width,omitempty"`
Height int `json:"height,omitempty"`
} `json:"bounding_box,omitempty"`
} `json:"tiny,omitempty"`
Thumb *struct {
URL string `json:"url,omitempty"`
BoundingBox *struct {
Width int `json:"width,omitempty"`
Height int `json:"height,omitempty"`
} `json:"bounding_box,omitempty"`
} `json:"thumb,omitempty"`
Small *struct {
URL string `json:"url,omitempty"`
BoundingBox *struct {
Width int `json:"width,omitempty"`
Height int `json:"height,omitempty"`
} `json:"bounding_box,omitempty"`
} `json:"small,omitempty"`
Medium *struct {
URL string `json:"url,omitempty"`
BoundingBox *struct {
Width int `json:"width,omitempty"`
Height int `json:"height,omitempty"`
} `json:"bounding_box,omitempty"`
} `json:"medium,omitempty"`
} `json:"avatar,omitempty"`
HeaderImageURL string `json:"header_image_url,omitempty"`
HumanReadableRoleForDisplay string `json:"human_readable_role_for_display,omitempty"`
ID int `json:"id,omitempty"`
IQ int `json:"iq,omitempty"`
Login string `json:"login,omitempty"`
Name string `json:"string,omitempty"`
RoleForDisplay string `json:"role_for_display,omitempty"`
URL string `json:"url,omitempty"`
CurrentUserMetadata *struct {
Permissions []string `json:"permissions,omitempty"`
ExcludedPermissions []string `json:"excluded_permissions,omitempty"`
Interactions *struct {
Following bool `json:"following,omitempty"`
} `json:"interactions,omitempty"`
} `json:"current_user_metadata,omitempty"`
}
type WebPagesService ¶
type WebPagesService service
Source Files
¶
Click to show internal directories.
Click to hide internal directories.