Difference between revisions of "OpenIdLogin class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>OpenIdLogin</nowiki> |Description=<nowiki>The OpenIdLogin object</nowiki> }}") |
|||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name=<nowiki>OpenIdLogin</nowiki> | |Name=<nowiki>OpenIdLogin</nowiki> | ||
| − | |Description=<nowiki>The | + | |Description=<nowiki>Respresents an association between a user and an openId identifier. This will allow the user to login by specifying the identifier (or the short version) with an openid=xxx url parameter on any link.</nowiki> |
| + | |Constructors= | ||
| + | {{CGscriptConstructors_Template|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=string|Name=<nowiki>claimedIdentifier</nowiki>|Description=<nowiki>The identifier (url) too lookup.</nowiki>}} | ||
| + | |Description=<nowiki>Fetch an existing association from the identifier.</nowiki>}} | ||
| + | {{CGscriptConstructors_Template|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=number|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource Id of the user to associate an openId with.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>claimedIdentifier</nowiki>|Description=<nowiki>The identifier (url) too create with. It must be unique across all users.</nowiki>}} | ||
| + | |Description=<nowiki>Create a new association between a user and an identifier.</nowiki>}} | ||
| + | {{CGscriptConstructors_Template|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=number|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource Id of the user to associate an openId with.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>site</nowiki>|Description=<nowiki>The site name of the foreign site. E.g. cg.catglobe.com</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>username</nowiki>|Description=<nowiki>The username on the foreign site</nowiki>}} | ||
| + | |Description=<nowiki>Create a new association between a user and an identifier on a catglobe site.</nowiki>}} | ||
| + | |Methods= | ||
| + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Destroy</nowiki>|Description=<nowiki>Remove the current association from the database.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the current association to the Database. Requires admin group access</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
| + | |Properties= | ||
| + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ClaimedIdentifier</nowiki>|HasGetter=1|Description=<nowiki>The identifier (url) of this association</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>UserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Resource id of the user having this association</nowiki>}} | ||
}} | }} | ||
| + | |||
| + | ==== <span style="color:#a52a2a;">'''Examples'''</span> ==== | ||
Revision as of 12:01, 19 December 2011
OpenIdLogin
Respresents an association between a user and an openId identifier. This will allow the user to login by specifying the identifier (or the short version) with an openid=xxx url parameter on any link.
Constructors
- (string claimedIdentifier "The identifier (url) too lookup.") - Fetch an existing association from the identifier.
- (number userResourceId "Resource Id of the user to associate an openId with.", string claimedIdentifier "The identifier (url) too create with. It must be unique across all users.") - Create a new association between a user and an identifier.
- (number userResourceId "Resource Id of the user to associate an openId with.", string site "The site name of the foreign site. E.g. cg.catglobe.com", string username "The username on the foreign site") - Create a new association between a user and an identifier on a catglobe site.
Methods
- Empty Destroy() - Remove the current association from the database.
- Empty Save() - Save the current association to the Database. Requires admin group access
- string ToString() - The string representation of the object.
Properties
- string ClaimedIdentifier { get; } - The identifier (url) of this association
- string ObjectTypeName { get; } - The name of the type of object.
- TypeInformation TypeInformation { get; } - Get information about this class.
- number UserResourceId { get; } - Resource id of the user having this association
