Functions - find message

From The Socknet

Jump to: navigation, search

find_message is used to discover messages that the user owns or knows about matching a filter.

Specification

POST find_message
{ from: { serviceid: "http://funny-message-remixer.com" },
  pagination: { 
               results_per_page: 15,
               page: 1
              },
  filter: ...
}

->
{ request: {
             from: { serviceid: "http://funny-message-remixer.com" },
             pagination: { 
               results_per_page: 15,
               page: 1
              },
             filter: ...
           },
  pagination: { 
                pages: 12,
                results_per_page: 15,
                page: 1
              },
  results: [ { guid: { 
                      openid: "http://example.com/david",
                      id: "23353"
                     },
               ...
             },
             ...
           ]
}

find_message may be called via GET or POST. When called via GET it generally gives the most recent messages posted by the user.

The request may include a pagination field.

The request may include a filter field.

The response must include a pagination field.

The response must include a results field holding an array of message objects as they would be transferred via get_message or notify_message depending on whether or not each message belongs to the user.

If the request used GET, the response should include a request object so that the requester can know what default conditions were used to find the messages.

Support

This function is optional for Providers and Services.

Further Reading

Personal tools