omero::api::IShare

Overview

[ "ami", "amd" ] interface IShare extends ServiceInterface

See IShare.html

Operation Index

activate
deactivate
getShare
getMemberCount
getOwnShares
getMemberShares
getSharesOwnedBy
getMemberSharesFor
getContents
getContentSubList
getContentSize
getContentMap
createShare
setDescription
setExpiration
setActive
closeShare
addObjects
addObject
removeObjects
removeObject
getCommentCount
getComments
addComment
addReply
deleteComment
getAllMembers
getAllGuests
getAllUsers
addUsers
addGuests
removeUsers
removeGuests
addUser
addGuest
removeUser
removeGuest
getActiveConnections
getPastConnections
invalidateConnection
getEvents
notifyMembersOfShare

Operations

void activate(long shareId) throws ServerError

void deactivate() throws ServerError

model::Share getShare(long shareId) throws ServerError

sys::CountMap getMemberCount(sys::LongList shareIds) throws ServerError

SessionList getOwnShares(bool active) throws ServerError

SessionList getMemberShares(bool active) throws ServerError

SessionList getSharesOwnedBy(model::Experimenter user, bool active) throws ServerError

SessionList getMemberSharesFor(model::Experimenter user, bool active) throws ServerError

IObjectList getContents(long shareId) throws ServerError

IObjectList getContentSubList(long shareId, int start, int finish) throws ServerError

int getContentSize(long shareId) throws ServerError

IdListMap getContentMap(long shareId) throws ServerError

long createShare(string description, RTime expiration, IObjectList items, ExperimenterList exps, StringSet guests, bool enabled) throws ServerError

void setDescription(long shareId, string description) throws ServerError

void setExpiration(long shareId, RTime expiration) throws ServerError

void setActive(long shareId, bool active) throws ServerError

void closeShare(long shareId) throws ServerError

void addObjects(long shareId, IObjectList iobjects) throws ServerError

void addObject(long shareId, model::IObject iobject) throws ServerError

void removeObjects(long shareId, IObjectList iobjects) throws ServerError

void removeObject(long shareId, model::IObject iobject) throws ServerError

sys::CountMap getCommentCount(sys::LongList shareIds) throws ServerError

AnnotationList getComments(long shareId) throws ServerError

model::TextAnnotation addComment(long shareId, string comment) throws ServerError

model::TextAnnotation addReply(long shareId, string comment, model::TextAnnotation replyTo) throws ServerError

void deleteComment(model::Annotation comment) throws ServerError

ExperimenterList getAllMembers(long shareId) throws ServerError

StringSet getAllGuests(long shareId) throws ServerError

StringSet getAllUsers(long shareId) throws ValidationException, ServerError

void addUsers(long shareId, ExperimenterList exps) throws ServerError

void addGuests(long shareId, StringSet emailAddresses) throws ServerError

void removeUsers(long shareId, ExperimenterList exps) throws ServerError

void removeGuests(long shareId, StringSet emailAddresses) throws ServerError

void addUser(long shareId, model::Experimenter exp) throws ServerError

void addGuest(long shareId, string emailAddress) throws ServerError

void removeUser(long shareId, model::Experimenter exp) throws ServerError

void removeGuest(long shareId, string emailAddress) throws ServerError

UserMap getActiveConnections(long shareId) throws ServerError

UserMap getPastConnections(long shareId) throws ServerError

void invalidateConnection(long shareId, model::Experimenter exp) throws ServerError

IObjectList getEvents(long shareId, model::Experimenter exp, RTime from, RTime to) throws ServerError

void notifyMembersOfShare(long shareId, string subject, string message, bool html) throws ServerError

Home

Index