synclets.json

A quick guide to the magical bits of how synclets are configured!

Here's an example twitter one, breakouts below:

{
    "provides":["contact/twitter", "mentions/twitter", "related/twitter", "timeline/twitter", "tweets/twitter"],
    "mongoId" : {
        "timeline":"id_str",
        "tweets":"id_str",
        "mentions":"id_str"
    },
    "types" : {
        "timeline":"tweet",
        "tweets":"tweet",
        "self":"contact",
        "mentions":"tweet"
    },
    "profileIds" : ["id_str", "screen_name"],
    "strip" : {
        "contact":["status"]
    },
    "synclets":[
        {"name": "self", "frequency": 7200},
        {"name": "friends", "frequency": 3600},
        {"name": "tweets", "frequency": 600},
        {"name": "timeline", "frequency": 120},
        {"name": "mentions", "frequency": 600},
        {"name": "related", "frequency": 3600},
        {"name": "tweet"}]
}

provides

    "provides":["contact/twitter", "mentions/twitter", "related/twitter", "timeline/twitter", "tweets/twitter"],

This is actually depreciated, it used to be a way to ask for a list of data based on a "type" but for any new connectors/synclets it can be ignored.

mongoId

    "mongoId" : {
        "timeline":"id_str",
        "tweets":"id_str",
        "mentions":"id_str"
    },

asdf

"types" : {
    "timeline":"tweet",
    "tweets":"tweet",
    "self":"contact",
    "mentions":"tweet"
},
"profileIds" : ["id_str", "screen_name"],
"strip" : {
    "contact":["status"]
},
"synclets":[
    {"name": "self", "frequency": 7200},
    {"name": "friends", "frequency": 3600},
    {"name": "tweets", "frequency": 600},
    {"name": "timeline", "frequency": 120},
    {"name": "mentions", "frequency": 600},
    {"name": "related", "frequency": 3600},
    {"name": "tweet"}]

}