META-INF.apidocs.nl.praegus.fitnesse.slim.fixtures.GmailOauthFixture.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-fixtures Show documentation
Show all versions of toolchain-fixtures Show documentation
Extensions on existing fixtures to aid in automated testing
{
"constructors" : [ {
"readableName" : "gmail oauth fixture",
"usage" : "| gmail oauth fixture | [appName] |",
"name" : "GmailOauthFixture",
"docString" : "Create a gmail connection for the given App\n@param appName The name of the application, as configured in the GmailAPI at Google",
"annotations" : [ ],
"parameters" : [ {
"name" : "appName",
"description" : "The name of the application, as configured in the GmailAPI at Google",
"type" : "String"
} ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.praegus.fitnesse.slim.fixtures.GmailOauthFixture",
"publicMethods" : [ {
"readableName" : "set client secret postfix",
"usage" : "| set client secret postfix | [clientSecretPostfix] | ",
"contexthelp" : "set client secret postfix <clientSecretPostfix>",
"name" : "setClientSecretPostfix",
"docString" : "Set a postfix for the client secret file. Useful when multiple GMail adresses are used in one project.\n@param clientSecretPostfix The postfix to use.",
"annotations" : [ ],
"parameters" : [ {
"name" : "clientSecretPostfix",
"description" : "The postfix to use.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set filter query",
"usage" : "| set filter query | [filterQuery] | ",
"contexthelp" : "set filter query <filterQuery>",
"name" : "setFilterQuery",
"docString" : "Set the filter query to filter the inbox.\n@param filterQuery The query to use. Documented at: https://support.google.com/mail/answer/7190",
"annotations" : [ ],
"parameters" : [ {
"name" : "filterQuery",
"description" : "The query to use. Documented at: https://support.google.com/mail/answer/7190",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set message format",
"usage" : "| set message format | [format] | ",
"contexthelp" : "set message format <format>",
"name" : "setMessageFormat",
"docString" : "Specify the message format of the message you expect.\n@param format The format: either plain (default) or html.",
"annotations" : [ ],
"parameters" : [ {
"name" : "format",
"description" : "The format: either plain (default) or html.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "latest message body",
"usage" : "| latest message body |",
"contexthelp" : "latest message body",
"name" : "latestMessageBody",
"docString" : "Get the body of the latest email message matching the specified search query. (Or newest in the inbox if no search query is specified)\n@return The body text (either plain text or HTML) as a String.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "save latest email body",
"usage" : "| save latest email body | [fileName] | ",
"contexthelp" : "save latest email body <fileName>",
"name" : "saveLatestEmailBody",
"docString" : "Save the body of the latest email message matching the specified search query. (Or newest in the inbox if no search query is specified) to a file\n@param fileName The filename to save the body to.\n@return a link to the created file",
"annotations" : [ ],
"parameters" : [ {
"name" : "fileName",
"description" : "The filename to save the body to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "latest message body contains",
"usage" : "| latest message body contains | [needle] | ",
"contexthelp" : "latest message body contains <needle>",
"name" : "latestMessageBodyContains",
"docString" : "Boolean value that shows if the latest (filtered) message contains the specified needle (String)\n@param needle The text to find\n@return true if needle was found, false otherwise",
"annotations" : [ ],
"parameters" : [ {
"name" : "needle",
"description" : "The text to find",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "latest message attachments",
"usage" : "| latest message attachments |",
"contexthelp" : "latest message attachments",
"name" : "latestMessageAttachments",
"docString" : "Get the attachment names from the latest (filtered) message\n@return a list of filenames attached to the message",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "List<String>"
}, {
"readableName" : "get link containing",
"usage" : "| get link containing | [needle] | ",
"contexthelp" : "get link containing <needle>",
"name" : "getLinkContaining",
"docString" : "Get a link from the latest (filtered) message that contains the specified needle (String)\n@param needle The text to search for\n@return the url if a matching url was found, otherwise return an empty String",
"annotations" : [ ],
"parameters" : [ {
"name" : "needle",
"description" : "The text to search for",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "trash current message",
"usage" : "| trash current message |",
"contexthelp" : "trash current message",
"name" : "trashCurrentMessage",
"docString" : "Move the latest (filterd) message to the trash folder\n@return true if the message was moved. False if no message was found.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete current message",
"usage" : "| delete current message |",
"contexthelp" : "delete current message",
"name" : "deleteCurrentMessage",
"docString" : "Permanently delete the latest (filtered) message\n@return true if the message was deleted. False if no message was found.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete all messages matching query",
"usage" : "| delete all messages matching query | [query] | ",
"contexthelp" : "delete all messages matching query <query>",
"name" : "deleteAllMessagesMatchingQuery",
"docString" : "Deletes all messages matching a given query. E.g. query \"in:inbox\" empties inbox. If no messages are found\n no delete is executed.\n@param query gmail query as described on https://support.google.com/mail/answer/7190?hl=en\n@throws IOException if no messages were found",
"annotations" : [ ],
"parameters" : [ {
"name" : "query",
"description" : "gmail query as described on https://support.google.com/mail/answer/7190?hl=en",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "void"
}, {
"readableName" : "send email",
"usage" : "| send email | [emailData] | ",
"contexthelp" : "send email <emailData>",
"name" : "sendEmail",
"docString" : "Send an email using data from the message map.\n@param emailData A map containing to, from, subject, body, attachment (optional) as strings.\n Attachment can be a wiki or absolute url pointing to a file to attach.\n@return true if sending completes successfully",
"annotations" : [ ],
"parameters" : [ {
"name" : "emailData",
"description" : "A map containing to, from, subject, body, attachment (optional) as strings.\n Attachment can be a wiki or absolute url pointing to a file to attach.",
"type" : "Map<String>"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "poll until message arrives",
"usage" : "| poll until message arrives |",
"contexthelp" : "poll until message arrives",
"name" : "pollUntilMessageArrives",
"docString" : "Poll the inbox until a message (matching the filter if specified) arrives.\n@return true if a message was found within the maximum number of retries, false otherwise",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set global value to",
"usage" : "| set global value | [symbolName] | to | [value] | ",
"contexthelp" : "set global value <symbolName> to <value>",
"name" : "setGlobalValueTo",
"docString" : "Stores a (global) value so it can be accessed by other fixtures/pages.\n@param symbolName name to store value under.\n@param value value to store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name to store value under.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to store.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "global value",
"usage" : "| global value | [symbolName] | ",
"contexthelp" : "global value <symbolName>",
"name" : "globalValue",
"docString" : "Retrieves a (global) value, which was previously stored using #setGlobalValueTo().\n@param symbolName name value was stored under.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name value was stored under.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "wait seconds",
"usage" : "| wait seconds | [i] | ",
"contexthelp" : "wait seconds <i>",
"name" : "waitSeconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait milliseconds",
"usage" : "| wait milliseconds | [i] | ",
"contexthelp" : "wait milliseconds <i>",
"name" : "waitMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set repeat interval to milliseconds",
"usage" : "| set repeat interval to milliseconds | [milliseconds] | ",
"contexthelp" : "set repeat interval to milliseconds <milliseconds>",
"name" : "setRepeatIntervalToMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "milliseconds",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat interval",
"usage" : "| repeat interval |",
"contexthelp" : "repeat interval",
"name" : "repeatInterval",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times | [maxCount] | ",
"contexthelp" : "repeat at most times <maxCount>",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "maxCount",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times |",
"contexthelp" : "repeat at most times",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "repeat count",
"usage" : "| repeat count |",
"contexthelp" : "repeat count",
"name" : "repeatCount",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "time spent repeating",
"usage" : "| time spent repeating |",
"contexthelp" : "time spent repeating",
"name" : "timeSpentRepeating",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
} ],
"typeName" : "nl.praegus.fitnesse.slim.fixtures.GmailOauthFixture",
"name" : "GmailOauthFixture",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy