package proto

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ArchiveFeed (stream Entry, FeedSummary)

  api.proto:26

  A client-to-server streaming RPC. Accepts a stream of Entries on a feed being archived, returning a FeedSummary when archving is completed.

• rpc BindUserFeed (OAuthUser, OAuthUser)

  api.proto:40

  rpc BindAuth(OAuthUser) returns (OAuthUser) {}

• rpc Command (CommandRequest, CommandResponse)

  api.proto:45

  message CommandRequest

  api.proto:83

  • string command = 1

  • string arg1 = 2

  • string arg2 = 3

  message CommandResponse

  api.proto:89

  • string command = 1

  • string result = 2

• rpc CommentEntry (CommentRequest, Entry)

  api.proto:35

  message CommentRequest

  api.proto:150

  • string entry = 1

  • optional Comment comment = 2

• rpc DeleteComment (CommentDeleteRequest, Entry)

  api.proto:36

  message CommentDeleteRequest

  api.proto:155

  • string entry = 1

  • string comment = 2

  • string user = 3

• rpc DeleteService (ServiceRequest, Feedinfo)

  api.proto:43

  service

  message ServiceRequest

  api.proto:161

  • string user = 1

  • string service = 2

• rpc EnqueJob (FeedJob, FeedJob)

  api.proto:11

• rpc FetchEntry (EntryRequest, Feed)

  api.proto:32

  Entry page return Feed as well

  message EntryRequest

  api.proto:136

  • string uuid = 1

• rpc FetchFeed (FeedRequest, Feed)

  api.proto:29

  message FeedRequest

  api.proto:121

  placeholder - Always true, indicating the entity is the placeholder body - The text we use for the placeholder on FriendFeed, e.g., "3 more comments" for comments or "234 other people" for likes num - The number of comments or likes excluded. For example, if the body is "3 more comments", then num would be 3. Example: http://friendfeed-api.com/v2/feed/bret?maxcomments=auto&maxlikes=auto

  • string id = 1

  • int32 start = 2

  • int32 page_size = 3

  • bool raw = 4

    Include raw text entry and comment bodies in addition to the HTML bodies included by default. The raw text bodies are available as rawBody on all returned entries and comments. This also adds rawLink on all entries.

  • int32 max_comments = 5

    NOTICE: this is not the same as original friendfeed api auto should be default it not set. if max_comments set to 1, then all comments should returned.

  • int32 max_likes = 6

• rpc FetchFeedinfo (ProfileRequest, Feedinfo)

  api.proto:19

• rpc FetchGraph (ProfileRequest, Graph)

  api.proto:17

  message Graph

  feed.proto:74

  social graph

  • map<string, Profile> subscribers = 1

  • map<string, Profile> subscriptions = 2

  • map<string, Profile> admins = 3

  • map<string, Profile> feeds = 4

  • map<string, Service> services = 5

• rpc FetchProfile (ProfileRequest, Profile)

  api.proto:16

• rpc FinishJob (FeedJob, FeedJob)

  api.proto:14

• rpc ForceArchiveFeed (stream Entry, FeedSummary)

  api.proto:27

• rpc GetFeedJob (Worker, FeedJob)

  api.proto:13

  message Worker

  api.proto:48

  • string Id = 1

  • optional Feed feed = 2

  • optional FeedJob job = 3

• rpc LikeEntry (LikeRequest, Entry)

  api.proto:34

  message LikeRequest

  api.proto:144

  • string entry = 1

  • string user = 2

  • bool like = 3

• rpc PostEntry (Entry, Entry)

  api.proto:33

• rpc PostFeedinfo (Feedinfo, Profile)

  api.proto:20

• rpc PutOAuth (OAuthUser, Profile)

  api.proto:38

Comment id - The id of the comment date - The date the comment was posted. body - The HTML body of the comment. URLs are turned into links. from{} - The user or group who posted this comment, a feed object via{}? - present if comment was created by a third party application. * name - the name of the application, e.g., "BuddyFeed" * url - URL of the source, e.g., "http://www.codewalrus.com/buddyfeed/" commands[]? - List of allowed commands for the authenticated user: "edit", "delete"

Used in: CommentRequest, Entry

• string id = 1

• string date = 2

• string body = 3

• string rawBody = 4

• optional Feed from = 5

• optional Via via = 6

• repeated string commands = 7

• bool placeholder = 8

  when maxcomments=auto on feed

• int32 num = 9

Entry id - The FriendFeed entry id, used to add comments/likes to the entry url - URL of the entry page on the FriendFeed website. date - The date the entry was posted. body - The HTML body of the entry. URLs are turned into links. A best effort is made to resolve shortened URLs and use the final destination as the title of the link. from{} - The user or group who posted this entry, a feed object to[]{}? - List of feeds to which this entry was published, a list of feed objects comments[]{}? - list of comments ordered by date likes[]{}? - list of likes for this entry, ordered to present the authenticated user's friends first, and then all other other people who liked the entry thumbnails[]{}? - List of thumbnails * url - Image URL * link - The URL the thumbnail should link to * width? - Image width * height? - Image height * player? - the player for this media file (e.g., the YouTube.com <embed> code) files[]{}? - List of files attached to this entry * url - File URL * type - File MIME type (e.g., "application/pdf") * name - File name * icon - URL of file type icon. Always 16x16. * size? - File size in bytes via{}? - If present, the application or service that created the entry. * name - The name of the entry source, e.g., "Google Reader", "Bookmarklet" * url - URL of the entry source geo{}? - Present if the entry contains geographic information * lat - The latitude * long - The longitude commands[]? - List of allowed commands for the authenticated user: "comment", "like", "unlike", "edit", "delete", "hide", "unhide"

Used as request type in: Api.ArchiveFeed, Api.ForceArchiveFeed, Api.PostEntry

Used as response type in: Api.CommentEntry, Api.DeleteComment, Api.LikeEntry, Api.PostEntry

Used as field type in: Feed, Feedinfo

• string id = 1

  entry uuid with prefix: "e/"

• string url = 2

• string date = 3

• string body = 4

• string rawBody = 5

• string rawLink = 6

• optional Feed from = 7

• repeated Feed to = 8

• repeated Comment comments = 9

• repeated Like likes = 10

• repeated Thumbnail thumbnails = 11

• repeated File files = 12

• optional Via via = 13

• optional Location geo = 14

• repeated string commands = 15

• string profile_uuid = 16

  custom filed TODO: duplicated with from field

Feed id - The feed id, e.g., "bret" or "bret/comments" name - Display name of the feed, e.g., "Bret Taylor" sup_id - Simple Update Protocol description? - Profile description, an HTML string type - One of "user", "group", or "special" private - true if the feed is private. commands[]? - List of allowed commands for the authenticated user on this feed: "subscribe", "unsubscribe", "post", "dm", "admin" Full feeds have all of the fields above, plus the following field: entries[]{} - List of the entries in this feed.

Used as response type in: Api.FetchEntry, Api.FetchFeed

Used as field type in: Comment, Entry, Like, Worker

• string uuid = 1

• string id = 2

• string name = 3

• string picture = 11

• string sup_id = 4

  SUP (Simple Update Protocol) https://code.google.com/p/simpleupdateprotocol/

• string description = 5

• string type = 6

  One of "user", "group", or "special"

• bool private = 7

  true if the feed is private

• repeated string commands = 8

• repeated Entry entries = 9

• string remote_key = 10

  TODO: remove this

Used as request type in: Api.EnqueJob, Api.FinishJob

Used as response type in: Api.EnqueJob, Api.FinishJob, Api.GetFeedJob

Used as field type in: Worker

• string key = 1

• string id = 2

• string remote_key = 3

• string target_id = 4

• int32 start = 5

• int32 page_size = 6

• string worker = 7

• int64 created = 8

• int64 updated = 9

• string uuid = 10

  uuid should always math target_id

• string status = 11

• int32 max_limit = 12

• bool force_update = 13

• optional Service service = 14

  translate to new service(sync) job

• optional Profile profile = 15

Used as response type in: Api.ArchiveFeed, Api.ForceArchiveFeed

• string id = 1

• int32 entry_count = 2

• string date_start = 3

• string date_end = 4

• int32 elapsed_time = 5

• user = 0

• group = 1

• special = 2

/feedinfo - Feed information Return information about the feed with the specified feed id: http://friendfeed-api.com/v2/feedinfo/feed id The response is a feed, plus the following fields: subscriptions[]? - The users and groups this feed is subscribed to subscribers[]? - The users subscribed to this feed admins[]{}? - For groups, the list of group administrators feeds[]? - For special feeds, the feeds that are contained within this feed. For example, for a friend list feed, this property lists all of the users/groups in the friend list. services[]{}? - Services associated with the feed (e.g., Twitter or an imported blog) * id - the service's id, e.g., "picasa" * name - the service's official name, e.g., "Picasa Web Albums" * url - the official URL of the service, e.g., "http://picasaweb.google.com/" * icon - the URL of the favicon for this service * profile? - the profile URL for this service, if any * username? - the username for this service, if any

Used as request type in: Api.PostFeedinfo

Used as response type in: Api.DeleteService, Api.FetchFeedinfo

• string uuid = 1

  Feed

• string id = 2

• string name = 3

• string picture = 16

• string sup_id = 4

  SUP (Simple Update Protocol) https://code.google.com/p/simpleupdateprotocol/

• string description = 5

• string type = 6

  One of "user", "group", or "special"

• bool private = 7

  true if the feed is private

• repeated string commands = 8

• repeated Entry entries = 9

• repeated Profile subscribers = 10

  Feedinfo

• repeated Profile subscriptions = 11

• repeated Profile admins = 12

• repeated Profile feeds = 13

  for list

• repeated Service services = 14

• string remote_key = 15

  TODO: remove this

File url - File URL type - File MIME type (e.g., "application/pdf") name - File name icon - URL of file type icon. Always 16x16. size? - File size in bytes

Used in: Entry

• string url = 1

• string type = 2

• string name = 3

• string icon = 4

• int32 size = 5

Like date from{} - The user who liked the parent entry.

Used in: Entry

• string date = 1

• optional Feed from = 2

• string body = 3

  when maxlikes=auto on feed

• bool placeholder = 8

• int32 num = 9

geographic information

Used in: Entry

• double latitude = 1

• double longitude = 2

Used as request type in: Api.BindUserFeed, Api.PutOAuth

Used as response type in: Api.BindUserFeed

Used as field type in: Service

• string uuid = 1

• string user_id = 2

  User info from oauth2 providers sequence

• string name = 3

  login

• string nick_name = 4

• string avater_url = 5

• string email = 6

• string access_token = 7

• string access_token_secret = 10

• string provider = 8

• string remote_key = 9

id map

Used as response type in: Api.FetchProfile, Api.PostFeedinfo, Api.PutOAuth

Used as field type in: FeedJob, Feedinfo, Graph

• string uuid = 1

  the FriendFeed UUID

• string id = 2

  v1 nicknameo or v2 id, in URL

• string name = 3

  the user's full name, display name

• string picture = 9

• string type = 4

  One of "user", "group", or "special"

• bool private = 5

  true if the feed is private

• string sup_id = 6

  SUP (Simple Update Protocol) https://code.google.com/p/simpleupdateprotocol/

• string description = 7

• string remote_key = 8

  TODO: remove this

• bool deleted = 10

  mark deletion, will purge all related data later

Used as request type in: Api.FetchFeedinfo, Api.FetchGraph, Api.FetchProfile

• string uuid = 1

services[]{}? - Services associated with the feed (e.g., Twitter or an imported blog) * id - the service's id, e.g., "picasa" * name - the service's official name, e.g., "Picasa Web Albums" * url - the official URL of the service, e.g., "http://picasaweb.google.com/" * icon - the URL of the favicon for this service * profile? - the profile URL for this service, if any * username? - the username for this service, if any

Used in: FeedJob, Feedinfo, Graph

• string id = 1

• string name = 2

• string icon = 3

• string profile = 4

• string username = 5

• optional OAuthUser oauth = 6

• int64 created = 7

• int64 updated = 8

• private = 0

• public = 1

thumbnails - List of thumbnails * url - Image URL * link - The URL the thumbnail should link to * width? - Image width * height? - Image height * player? - the player for this media file (e.g., the YouTube.com <embed> code)

Used in: Entry

• string url = 1

• string link = 2

• int32 width = 3

• int32 height = 4

• string player = 5

status - private or public id - the user's FriendFeed UUID name - the user's full name nickname - the user's FriendFeed nickname, used in FriendFeed URLs profileUrl - the user's profile URL on FriendFeed services[] - the services connected to the user's account * id - the service's FriendFeed ID, e.g., "picasa" * name - the service's official name, e.g., "Picasa Web Albums" * url - the official URL of the service, e.g., http://picasaweb.google.com/ * iconUrl - the URL of the favicon for this service * profileUrl? - the user's profile URL on this service, if any * username? - the user's username for this service, if any subscriptions[] - the users this user is subscribed to * id * name * nickname * profileUrl rooms[] - the rooms this user is a member of * id - the room's FriendFeed UUID * name - the room's display name * nickname - the room's FriendFeed nickname, used in FriendFeed URLs * url - the room's URL on FriendFeed lists[] - the lists this user is a member of (only visible if authenticated as this user) * id - the list's FriendFeed UUID * name - the list's display name * nickname - the list's FriendFeed nickname, used in FriendFeed URLs * url - the list's URL on FriendFeed

• string status = 1

• string id = 2

  FriendFeed UUID

• string name = 3

  full name

• string nickname = 4

  used in URL

• string profileUrl = 5

• repeated V1Profile services = 6

• repeated V1Profile subscriptions = 7

• repeated V1Profile rooms = 8

• repeated V1Profile lists = 9

Via name - the name of the application, e.g., "BuddyFeed" url - URL of the source, e.g., "http://www.codewalrus.com/buddyfeed/"

Used in: Comment, Entry

• string name = 1

• string url = 2