C# Класс BCXAPI.Service

Показать файл Открыть проект

Открытые методы

Метод Описание
GetAccessToken ( string code ) : dynamic

step 2: Given a code that the url from GetRequestAuthorizationURL eventually redirects back to and the clientsecret you can get an access token. store this token somewhere as you need to provide it to this wrapper to make calls.
GetAccessesForCalendar ( int accountID, int calendarID ) : dynamic
GetAccessesForProject ( int accountID, int projectID ) : dynamic
GetAccounts ( ) : dynamic
GetAttachments ( int accountID, int projectID ) : dynamic
GetCalendar ( int accountID, int calendarID ) : dynamic
GetCalendarEvent ( int accountID, int calendarID, int calendarEventID ) : dynamic
GetCalendarEventForProject ( int accountID, int projectID, int calendarEventID ) : dynamic
GetCalendarEvents ( int accountID, int calendarID, bool past = false ) : dynamic
GetCalendarEventsForProject ( int accountID, int projectID, bool past = false ) : dynamic
GetCalendars ( int accountID ) : dynamic
GetDocument ( int accountID, int projectID, int documentID ) : dynamic
GetDocuments ( int accountID, int projectID ) : dynamic
GetGlobalEvents ( int accountID, System.DateTime since = null, int page = 1 ) : dynamic
GetMessage ( int accountID, int projectID, int messageID ) : dynamic
GetPeople ( int accountID ) : dynamic
GetPerson ( int accountID, int personID ) : dynamic
GetPersonEvents ( int accountID, int personID, System.DateTime since = null, int page = 1 ) : dynamic
GetProject ( int accountID, int projectID ) : dynamic
GetProjectEvents ( int accountID, int projectID, System.DateTime since = null, int page = 1 ) : dynamic
GetProjects ( int accountID, bool archived = false ) : dynamic
GetRequestAuthorizationURL ( string>.Dictionary optionalArguments = null ) : string

step 1: get the URL to redirect your users to
GetTodo ( int accountID, int projectID, int todoID ) : dynamic
GetTodoList ( int accountID, int projectID, int todoListID ) : dynamic
GetTodoLists ( int accountID, int projectID, bool completed = false ) : dynamic
GetTodoListsWithAssignedTodos ( int accountID, int personID ) : dynamic
GetTopics ( int accountID, int projectID ) : dynamic
GetUpload ( int accountID, int projectID, int uploadID ) : dynamic
RefreshAccessToken ( ) : dynamic

call this when you get a TokenExpired exception and store the new access token for future requests
Service ( string clientID, string clientSecret, string redirectURI, string appNameAndContact, BCXAPI cache = null, dynamic accessToken = null ) : System

create a service class with an authorization token retrieved from GetAuthToken (if you have it). If you do not provide one then you will only be able to get the URL to the basecamp authorization requested page and to validate a code returned to you by that authorization. parameters come from the app you set up at integrate.37signals.com

Приватные методы

Метод Описание
_getJSONFromURL ( string url ) : dynamic

helper method to make a get request to basecamp. checks cache first if you've already received that response and checks with basecamp if you need to update your cache.

Описание методов

GetAccessToken() публичный Метод

step 2: Given a code that the url from GetRequestAuthorizationURL eventually redirects back to and the clientsecret you can get an access token. store this token somewhere as you need to provide it to this wrapper to make calls.
public GetAccessToken ( string code ) : dynamic
code string the code given to you by basecamp
Результат dynamic

GetAccessesForCalendar() публичный Метод

public GetAccessesForCalendar ( int accountID, int calendarID ) : dynamic
accountID int
calendarID int
Результат dynamic

GetAccessesForProject() публичный Метод

public GetAccessesForProject ( int accountID, int projectID ) : dynamic
accountID int
projectID int
Результат dynamic

GetAccounts() публичный Метод

public GetAccounts ( ) : dynamic
Результат dynamic

GetAttachments() публичный Метод

public GetAttachments ( int accountID, int projectID ) : dynamic
accountID int
projectID int
Результат dynamic

GetCalendar() публичный Метод

public GetCalendar ( int accountID, int calendarID ) : dynamic
accountID int
calendarID int
Результат dynamic

GetCalendarEvent() публичный Метод

public GetCalendarEvent ( int accountID, int calendarID, int calendarEventID ) : dynamic
accountID int
calendarID int
calendarEventID int
Результат dynamic

GetCalendarEventForProject() публичный Метод

public GetCalendarEventForProject ( int accountID, int projectID, int calendarEventID ) : dynamic
accountID int
projectID int
calendarEventID int
Результат dynamic

GetCalendarEvents() публичный Метод

public GetCalendarEvents ( int accountID, int calendarID, bool past = false ) : dynamic
accountID int
calendarID int
past bool
Результат dynamic

GetCalendarEventsForProject() публичный Метод

public GetCalendarEventsForProject ( int accountID, int projectID, bool past = false ) : dynamic
accountID int
projectID int
past bool
Результат dynamic

GetCalendars() публичный Метод

public GetCalendars ( int accountID ) : dynamic
accountID int
Результат dynamic

GetDocument() публичный Метод

public GetDocument ( int accountID, int projectID, int documentID ) : dynamic
accountID int
projectID int
documentID int
Результат dynamic

GetDocuments() публичный Метод

public GetDocuments ( int accountID, int projectID ) : dynamic
accountID int
projectID int
Результат dynamic

GetGlobalEvents() публичный Метод

public GetGlobalEvents ( int accountID, System.DateTime since = null, int page = 1 ) : dynamic
accountID int
since System.DateTime
page int
Результат dynamic

GetMessage() публичный Метод

public GetMessage ( int accountID, int projectID, int messageID ) : dynamic
accountID int
projectID int
messageID int
Результат dynamic

GetPeople() публичный Метод

public GetPeople ( int accountID ) : dynamic
accountID int
Результат dynamic

GetPerson() публичный Метод

public GetPerson ( int accountID, int personID ) : dynamic
accountID int
personID int
Результат dynamic

GetPersonEvents() публичный Метод

public GetPersonEvents ( int accountID, int personID, System.DateTime since = null, int page = 1 ) : dynamic
accountID int
personID int
since System.DateTime
page int
Результат dynamic

GetProject() публичный Метод

public GetProject ( int accountID, int projectID ) : dynamic
accountID int
projectID int
Результат dynamic

GetProjectEvents() публичный Метод

public GetProjectEvents ( int accountID, int projectID, System.DateTime since = null, int page = 1 ) : dynamic
accountID int
projectID int
since System.DateTime
page int
Результат dynamic

GetProjects() публичный Метод

public GetProjects ( int accountID, bool archived = false ) : dynamic
accountID int
archived bool
Результат dynamic

GetRequestAuthorizationURL() публичный Метод

step 1: get the URL to redirect your users to
public GetRequestAuthorizationURL ( string>.Dictionary optionalArguments = null ) : string
optionalArguments string>.Dictionary pass in this optional parameter to get these key value pairs passed back to your redirect URL in the query string
Результат string

GetTodo() публичный Метод

public GetTodo ( int accountID, int projectID, int todoID ) : dynamic
accountID int
projectID int
todoID int
Результат dynamic

GetTodoList() публичный Метод

public GetTodoList ( int accountID, int projectID, int todoListID ) : dynamic
accountID int
projectID int
todoListID int
Результат dynamic

GetTodoLists() публичный Метод

public GetTodoLists ( int accountID, int projectID, bool completed = false ) : dynamic
accountID int
projectID int
completed bool
Результат dynamic

GetTodoListsWithAssignedTodos() публичный Метод

public GetTodoListsWithAssignedTodos ( int accountID, int personID ) : dynamic
accountID int
personID int
Результат dynamic

GetTopics() публичный Метод

public GetTopics ( int accountID, int projectID ) : dynamic
accountID int
projectID int
Результат dynamic

GetUpload() публичный Метод

public GetUpload ( int accountID, int projectID, int uploadID ) : dynamic
accountID int
projectID int
uploadID int
Результат dynamic

RefreshAccessToken() публичный Метод

call this when you get a TokenExpired exception and store the new access token for future requests
public RefreshAccessToken ( ) : dynamic
Результат dynamic

Service() публичный Метод

create a service class with an authorization token retrieved from GetAuthToken (if you have it). If you do not provide one then you will only be able to get the URL to the basecamp authorization requested page and to validate a code returned to you by that authorization. parameters come from the app you set up at integrate.37signals.com
public Service ( string clientID, string clientSecret, string redirectURI, string appNameAndContact, BCXAPI cache = null, dynamic accessToken = null ) : System
clientID string your client id from 37s
clientSecret string your client secret from 37s
redirectURI string the redirect URI you set up with 37s - this must match
appNameAndContact string your application name and contact info - added to your request header
cache BCXAPI an optional cache to use for caching responses from 37s. if you don't provide one, it'll use the System.Runtime.Caching.MemoryCache.Default cache
accessToken dynamic if you have an access token, provide it here. this is the entire json object returned from the call to GetAccessToken
Результат System