[This is preliminary documentation and is subject to change.]
The SocialNetwork type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | SocialNetwork | Initializes a new instance of the SocialNetwork class |
Methods
Name | Description | |
---|---|---|
![]() | ____ObtainPrivateServiceStatusLockObject |
WARNING: Developers never call this method!!!
It is used by advanced derived implementations that need to synchronize status updates.
We do not want to make statuslock protected as it is almost never needed, hence this accessor
(Inherited from Service.) |
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AbortStart |
Allows to abort unsuccessful DoStart() overridden implementation.
This method must be called from within DoStart()
(Inherited from Service.) |
![]() | AcceptManagerVisit |
Accepts a visit of a manager entity - this call is useful for periodic updates of service status,
i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method.
The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
(Inherited from Service.) |
![]() ![]() | AutoStartNetworks | |
![]() | CheckForCompleteStop |
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.) |
![]() | CheckServiceActive |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceActiveOrStarting |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceInactive |
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.) |
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | CreateSocialUserInfo |
Create an instance of social user info class.
If parameters are null then creates new non-logged-in instance, otherwise, if parameters are set,
then connects to network and tries to re-initializes SocialUser info with fresh data
from the network (i.e. name, gender etc.) using the supplied net tokens, or throws if tokens are invalid (i.e. expired).
This returned instance is usually stored in session for later use
|
![]() | Destructor | (Overrides Service Destructor .) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoAcceptManagerVisit | (Overrides Service DoAcceptManagerVisit(Object, DateTime).) |
![]() | DoCheckForCompleteStop |
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.) |
![]() | DoConfigure |
Provides implementation that configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | DoObtainTokens | |
![]() | DoPostMessage | |
![]() | DoRetrieveLongTermTokens | |
![]() | DoRetrieveUserInfo | |
![]() | DoSignalStop |
Provides implementation that signals service to stop. This is expected not to block
(Inherited from Service.) |
![]() | DoStart | (Overrides Service DoStart .) |
![]() | DoWaitForCompleteStop | (Overrides Service DoWaitForCompleteStop .) |
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | Equals | (Overrides ![]() |
![]() | ExternalGetParameter |
Gets external parameter value returning true if parameter was found
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalParametersForGroups |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() ![]() | GenerateNonce | |
![]() | GetExternalLoginReference |
Returns href to login via social system/site
|
![]() | GetHashCode | (Overrides ![]() |
![]() | GetPicture |
Returns user profile image or null if no image available.
Picture kind specifies classification of pictures within profile i.e. "main", "small-icon" etc.
|
![]() | GetPictureData |
Returns user profile image data along with content type or null if no image available.
Picture kind specifies classification of pictures within profile i.e. "main", "small-icon" etc.
|
![]() | GetSpecifiedExternalLoginReference |
Returns social service login URL for "two-stage" login networks.
Currently twitter only requires this
|
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() ![]() | IsAnySocialNetBotUserAgent |
Returns true if the user agent represents a robot from any known social net
|
![]() ![]() | IsSpecificSocialNetBotUserAgent |
Returns true if the user agent represents a robot from the specified social net
|
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | ObtainTokensAndFillInfo |
Fills user info with values from social network
|
![]() | PostMessage |
Post message to social network
|
![]() | PrepareReturnURLParameter | |
![]() | RenewLongTermTokens |
Refreshes long term tokens (if provider needs them).
Should be used in scenario like background server-side token renew routine
|
![]() | RetrieveUserInfo |
Retrieves all user fields (e.g. screen name, email) but tokens.
|
![]() | SignalStop |
Non-blocking call that initiates the stopping of the service
(Inherited from Service.) |
![]() | Start |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | StartByApplication |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | ToString | (Overrides ![]() |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
(Inherited from Service.) |
![]() | WaitForCompleteStop |
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.) |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() ![]() | CONFIG_AUTO_START_ATTR | |
![]() ![]() | DEFAULT_TIMEOUT_MS_DEFAULT | |
![]() ![]() | SOCIAL_ACTION_PARAMNAME | |
![]() ![]() | SOCIAL_PARAMNAME | |
![]() ![]() | SOCIALACTION_SPECIFYURL_PARAMVALUE | |
![]() ![]() | SOCIALPOST_PARAMNAME | |
![]() ![]() | SOCIALPOSTMESSAGE_PARAMNAME |
Properties
Name | Description | |
---|---|---|
![]() | ApplicationDontAutoStartService |
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.) |
![]() | CanPost |
Defines if a meeesage can be post to this social network
|
![]() | ComponentCommonName | (Overrides ApplicationComponent ComponentCommonName.) |
![]() | ComponentDirector | (Inherited from Service TDirector .) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | CredentialsEntry |
Specifies how service takes user credentials
|
![]() | Description |
Provides social network description, this default implementation returns the name of the class
|
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | ExternalParameters |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | GrantAccessFriends | |
![]() | GrantAccessProfile | |
![]() | GrantPost | |
![]() | GrantViewEmail | |
![]() | ID |
Globally uniquelly identifies social network architype
|
![]() ![]() | Instances |
Returns the read-only registry of social networks currently activated
|
![]() | InstrumentationEnabled |
Implements IInstrumentable
(Overrides ServiceWithInstrumentationBase TDirector InstrumentationEnabled.) |
![]() | KeepAlive |
Sets if pipelining should be used for web request
|
![]() | LocalizedTime |
Returns current time localized per TimeLocation
(Inherited from Service.) |
![]() | Name |
Provides textual name for the service
(Inherited from Service.) |
![]() | Pipelined |
Sets keepalive option for web request
|
![]() | RequiresSpecifiedExternalLoginReference |
Specifies if this provider requires to obtain temporary token before redirecting to social network login page.
Currently only Twitter requires this routine
|
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
(Inherited from Service.) |
![]() | ServiceURL |
Returns the root public URL for the service
|
![]() | Status |
Current service status
(Inherited from Service.) |
![]() | TimeLocation |
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.) |
![]() | WebServiceCallTimeoutMs |
Sets timeout for calls to external service that imlements this social network
|
See Also