C# Класс Piwik.Analytics.Modules.UsersManager

Service Gateway for Piwik UsersManager Module API For more information, see http://developer.piwik.org/api-reference/reporting-api#SitesManager
This Analytics API is tested against Piwik 2.16.5
Наследование: PiwikAnalytics
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
addUser ( string userLogin, string password, string email, string alias = null ) : Hashtable

Add a piwik user

deleteUser ( string userLogin ) : Hashtable

Delete a piwik user

getSitesAccessFromUser ( string userLogin ) : ArrayList

Get all sites and the specific access level (view or admin) where the given user has access to

getTokenAuth ( string userLogin, string md5Password ) : string

Calculates the token auth by using a user login and a md5 hashed password

getUser ( string userLogin ) : ArrayList

Get a piwik user by login

getUserByEmail ( string userEmail ) : ArrayList

Get a piwik user by email

getUserLoginFromUserEmail ( string userEmail ) : string

Get the login for a piwik user with a given email

getUserPreference ( string userLogin, string preferenceName ) : object

Get a piwik user preference

getUsers ( string userLogins = null ) : ArrayList

Get all piwik users with the given list of logins

getUsersAccessFromSite ( int idSite ) : ArrayList

Get all piwik users and their access level for the piwik site with the given id

getUsersHavingSuperUserAccess ( ) : ArrayList

Get all piwik users which have super user access

getUsersLogin ( ) : ArrayList

Get user logins of all registered piwik users

getUsersSitesFromAccess ( UserAccess access ) : Hashtable

Get all piwik users and their sites where they have the given access level

getUsersWithSiteAccess ( int idSite, UserAccess access ) : ArrayList

Get all piwik users which have the given access to the piwik site with the given id

hasSuperUserAccess ( ) : bool

Check if the current piwik user has super user access

setSuperUserAccess ( string userLogin, bool hasSuperUserAccess ) : Hashtable

Define if a piwik user with the given login has super user access

setUserAccess ( string userLogin, UserAccess access, int idSites ) : Hashtable

Set the access of a piwik user on a list of site ids

setUserPreference ( string userLogin, string preferenceName, object preferenceValue ) : Hashtable

Set a piwik user preference

updateUser ( string userLogin, string password = null, string email = null, string alias = null ) : Hashtable

Update a piwik user

userEmailExists ( string userEmail ) : bool

Check if a piwik user with given email exists

userExists ( string userLogin ) : bool

Check if a piwik user with given login exists

Защищенные методы

Метод Описание
getPlugin ( ) : string

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

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

Add a piwik user
public addUser ( string userLogin, string password, string email, string alias = null ) : Hashtable
userLogin string
password string
email string
alias string
Результат System.Collections.Hashtable

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

Delete a piwik user
public deleteUser ( string userLogin ) : Hashtable
userLogin string
Результат System.Collections.Hashtable

getPlugin() защищенный Метод

protected getPlugin ( ) : string
Результат string

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

Get all sites and the specific access level (view or admin) where the given user has access to
public getSitesAccessFromUser ( string userLogin ) : ArrayList
userLogin string
Результат System.Collections.ArrayList

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

Calculates the token auth by using a user login and a md5 hashed password
public getTokenAuth ( string userLogin, string md5Password ) : string
userLogin string
md5Password string
Результат string

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

Get a piwik user by login
public getUser ( string userLogin ) : ArrayList
userLogin string
Результат System.Collections.ArrayList

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

Get a piwik user by email
public getUserByEmail ( string userEmail ) : ArrayList
userEmail string
Результат System.Collections.ArrayList

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

Get the login for a piwik user with a given email
public getUserLoginFromUserEmail ( string userEmail ) : string
userEmail string
Результат string

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

Get a piwik user preference
public getUserPreference ( string userLogin, string preferenceName ) : object
userLogin string
preferenceName string
Результат object

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

Get all piwik users with the given list of logins
public getUsers ( string userLogins = null ) : ArrayList
userLogins string
Результат System.Collections.ArrayList

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

Get all piwik users and their access level for the piwik site with the given id
public getUsersAccessFromSite ( int idSite ) : ArrayList
idSite int
Результат System.Collections.ArrayList

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

Get all piwik users which have super user access
public getUsersHavingSuperUserAccess ( ) : ArrayList
Результат System.Collections.ArrayList

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

Get user logins of all registered piwik users
public getUsersLogin ( ) : ArrayList
Результат System.Collections.ArrayList

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

Get all piwik users and their sites where they have the given access level
public getUsersSitesFromAccess ( UserAccess access ) : Hashtable
access UserAccess
Результат System.Collections.Hashtable

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

Get all piwik users which have the given access to the piwik site with the given id
public getUsersWithSiteAccess ( int idSite, UserAccess access ) : ArrayList
idSite int
access UserAccess
Результат System.Collections.ArrayList

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

Check if the current piwik user has super user access
public hasSuperUserAccess ( ) : bool
Результат bool

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

Define if a piwik user with the given login has super user access
public setSuperUserAccess ( string userLogin, bool hasSuperUserAccess ) : Hashtable
userLogin string
hasSuperUserAccess bool
Результат System.Collections.Hashtable

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

Set the access of a piwik user on a list of site ids
public setUserAccess ( string userLogin, UserAccess access, int idSites ) : Hashtable
userLogin string
access UserAccess
idSites int
Результат System.Collections.Hashtable

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

Set a piwik user preference
public setUserPreference ( string userLogin, string preferenceName, object preferenceValue ) : Hashtable
userLogin string
preferenceName string
preferenceValue object
Результат System.Collections.Hashtable

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

Update a piwik user
public updateUser ( string userLogin, string password = null, string email = null, string alias = null ) : Hashtable
userLogin string
password string
email string
alias string
Результат System.Collections.Hashtable

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

Check if a piwik user with given email exists
public userEmailExists ( string userEmail ) : bool
userEmail string
Результат bool

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

Check if a piwik user with given login exists
public userExists ( string userLogin ) : bool
userLogin string
Результат bool