\section{\-Getopt \-Class \-Reference}
\label{interface_getopt}\index{\-Getopt@{\-Getopt}}


{\ttfamily \#import $<$\-Getopt.\-h$>$}

\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
(void) -\/ {\bf init\-Getopt\-:}
\item 
(\-B\-O\-O\-L) -\/ {\bf response\-Is\-Valid}
\item 
(\-N\-S\-String $\ast$) -\/ {\bf get\-Message}
\item 
(\-N\-S\-String $\ast$) -\/ {\bf get\-Response\-Status}
\item 
(int) -\/ {\bf get\-Response\-Code}
\item 
(\-N\-S\-Mutable\-Array $\ast$) -\/ {\bf get\-Campaigns\-Id\-List}
\item 
(\-N\-S\-Mutable\-Array $\ast$) -\/ {\bf get\-Campaign\-Status\-List}
\item 
(\-N\-S\-Mutable\-Array $\ast$) -\/ {\bf get\-Campaign\-Status\-Code\-List}
\item 
(int) -\/ {\bf get\-Campaign\-Status\-Code\-:}
\item 
(\-N\-S\-String $\ast$) -\/ {\bf get\-Campaign\-Status\-:}
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}
\doxyref{\-Getopt.\-h}{p.}{_getopt_8h_source} \-Mercury\-\_\-i\-O\-S

\-Created by \-Julien \-Salvi on 9/12/11. \-Copyright 2011 \-Mogreet \-Inc. \-All rights reserved.

\-This file is part of \doxyref{\-Mercury}{p.}{interface_mercury}.

\doxyref{\-Mercury}{p.}{interface_mercury} is free software\-: you can redistribute it and/or modify it under the terms of the \-G\-N\-U \-General \-Public \-License as published by the \-Free \-Software \-Foundation, either version 3 of the \-License, or (at your option) any later version.

\doxyref{\-Mercury}{p.}{interface_mercury} is distributed in the hope that it will be useful, but \-W\-I\-T\-H\-O\-U\-T \-A\-N\-Y \-W\-A\-R\-R\-A\-N\-T\-Y; without even the implied warranty of \-M\-E\-R\-C\-H\-A\-N\-T\-A\-B\-I\-L\-I\-T\-Y or \-F\-I\-T\-N\-E\-S\-S \-F\-O\-R \-A \-P\-A\-R\-T\-I\-C\-U\-L\-A\-R \-P\-U\-R\-P\-O\-S\-E. \-See the \-G\-N\-U \-General \-Public \-License for more details.

\-You should have received a copy of the \-G\-N\-U \-General \-Public \-License along with \doxyref{\-Mercury}{p.}{interface_mercury}. \-If not, see $<${\tt http\-://www.\-gnu.\-org/licenses/}$>$. \-The \doxyref{\-Getopt}{p.}{interface_getopt} object contains the response from a \doxyref{\-Mercury\#getopt}{p.}{} request to the \-Mo\-M\-S \-A\-P\-I.

\-Getopt.\-m \-Mercury\-\_\-i\-O\-S

\-Created by \-Julien \-Salvi on 9/12/11. \-Copyright 2011 \-Mogreet \-Inc. \-All rights reserved.

\-This file is part of \doxyref{\-Mercury}{p.}{interface_mercury}.

\doxyref{\-Mercury}{p.}{interface_mercury} is free software\-: you can redistribute it and/or modify it under the terms of the \-G\-N\-U \-General \-Public \-License as published by the \-Free \-Software \-Foundation, either version 3 of the \-License, or (at your option) any later version.

\doxyref{\-Mercury}{p.}{interface_mercury} is distributed in the hope that it will be useful, but \-W\-I\-T\-H\-O\-U\-T \-A\-N\-Y \-W\-A\-R\-R\-A\-N\-T\-Y; without even the implied warranty of \-M\-E\-R\-C\-H\-A\-N\-T\-A\-B\-I\-L\-I\-T\-Y or \-F\-I\-T\-N\-E\-S\-S \-F\-O\-R \-A \-P\-A\-R\-T\-I\-C\-U\-L\-A\-R \-P\-U\-R\-P\-O\-S\-E. \-See the \-G\-N\-U \-General \-Public \-License for more details.

\-You should have received a copy of the \-G\-N\-U \-General \-Public \-License along with \doxyref{\-Mercury}{p.}{interface_mercury}. \-If not, see $<${\tt http\-://www.\-gnu.\-org/licenses/}$>$. 

\subsection{\-Member \-Function \-Documentation}
\index{\-Getopt@{\-Getopt}!get\-Campaigns\-Id\-List@{get\-Campaigns\-Id\-List}}
\index{get\-Campaigns\-Id\-List@{get\-Campaigns\-Id\-List}!Getopt@{\-Getopt}}
\subsubsection[{get\-Campaigns\-Id\-List}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (\-N\-S\-Mutable\-Array $\ast$) get\-Campaigns\-Id\-List 
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
}\label{interface_getopt_ae67bd34f9a6eefb6991c0d1ba4f1ab5e}
\-Gets the campaign \-I\-Ds. \begin{DoxyReturn}{\-Returns}
\-An \-N\-S\-Mutable\-Array that contains all the campaigns \-I\-D. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!get\-Campaign\-Status\-:@{get\-Campaign\-Status\-:}}
\index{get\-Campaign\-Status\-:@{get\-Campaign\-Status\-:}!Getopt@{\-Getopt}}
\subsubsection[{get\-Campaign\-Status\-:}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (\-N\-S\-String $\ast$) get\-Campaign\-Status\-: 
\begin{DoxyParamCaption}
\item[{dummy(\-N\-S\-String$\ast$)}]{campaign\-Id}
\end{DoxyParamCaption}
}\label{interface_getopt_ae462b8840809c38907beeb65600207c3}
\-Gets a campaign status. 
\begin{DoxyParams}{\-Parameters}
{\em campaign\-Id} & \-The campaign \-I\-D. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{\-Returns}
\-The campaign status of the specified campaign. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!get\-Campaign\-Status\-Code\-:@{get\-Campaign\-Status\-Code\-:}}
\index{get\-Campaign\-Status\-Code\-:@{get\-Campaign\-Status\-Code\-:}!Getopt@{\-Getopt}}
\subsubsection[{get\-Campaign\-Status\-Code\-:}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (int) get\-Campaign\-Status\-Code\-: 
\begin{DoxyParamCaption}
\item[{dummy(\-N\-S\-String$\ast$)}]{campaign\-Id}
\end{DoxyParamCaption}
}\label{interface_getopt_a3c5d5461767b0b60b87640e9bed50fa0}
\-Gets a campaign status code. 
\begin{DoxyParams}{\-Parameters}
{\em campaign\-Id} & \-The campaign \-I\-D. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{\-Returns}
\-The campaign status code of the specified campaign. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!get\-Campaign\-Status\-Code\-List@{get\-Campaign\-Status\-Code\-List}}
\index{get\-Campaign\-Status\-Code\-List@{get\-Campaign\-Status\-Code\-List}!Getopt@{\-Getopt}}
\subsubsection[{get\-Campaign\-Status\-Code\-List}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (\-N\-S\-Mutable\-Array $\ast$) get\-Campaign\-Status\-Code\-List 
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
}\label{interface_getopt_a9f7cb55ae8322091c2ed5d6b3778cf96}
\-Gets the campaign status codes. \begin{DoxyReturn}{\-Returns}
\-An \-N\-S\-Mutable\-Array that contains all the campaign status codes. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!get\-Campaign\-Status\-List@{get\-Campaign\-Status\-List}}
\index{get\-Campaign\-Status\-List@{get\-Campaign\-Status\-List}!Getopt@{\-Getopt}}
\subsubsection[{get\-Campaign\-Status\-List}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (\-N\-S\-Mutable\-Array $\ast$) get\-Campaign\-Status\-List 
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
}\label{interface_getopt_ab734e471e2498b2e174e13888e1f47d1}
\-Gets the campaign status. \begin{DoxyReturn}{\-Returns}
\-An \-N\-S\-Mutable\-Array that contains all the campaigns status. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!get\-Message@{get\-Message}}
\index{get\-Message@{get\-Message}!Getopt@{\-Getopt}}
\subsubsection[{get\-Message}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (\-N\-S\-String $\ast$) get\-Message 
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
}\label{interface_getopt_acd07f968bb1f707190fcbed50f4ffd5b}
\begin{DoxyReturn}{\-Returns}
\-The \-Message. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!get\-Response\-Code@{get\-Response\-Code}}
\index{get\-Response\-Code@{get\-Response\-Code}!Getopt@{\-Getopt}}
\subsubsection[{get\-Response\-Code}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (int) get\-Response\-Code 
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
}\label{interface_getopt_a13d89e7b1be7fd70ca00d4dc8fd4bf76}
\begin{DoxyReturn}{\-Returns}
\-The response \-Code. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!get\-Response\-Status@{get\-Response\-Status}}
\index{get\-Response\-Status@{get\-Response\-Status}!Getopt@{\-Getopt}}
\subsubsection[{get\-Response\-Status}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (\-N\-S\-String $\ast$) get\-Response\-Status 
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
}\label{interface_getopt_a37a6fb2220efa93c9dbe42888df9607b}
\begin{DoxyReturn}{\-Returns}
\-The response \-Status. 
\end{DoxyReturn}
\index{\-Getopt@{\-Getopt}!init\-Getopt\-:@{init\-Getopt\-:}}
\index{init\-Getopt\-:@{init\-Getopt\-:}!Getopt@{\-Getopt}}
\subsubsection[{init\-Getopt\-:}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (void) init\-Getopt\-: 
\begin{DoxyParamCaption}
\item[{dummy(\-N\-S\-String$\ast$)}]{url\-Getopt}
\end{DoxyParamCaption}
}\label{interface_getopt_a30a685ebe3d4b445be6a116147f0a524}
\-Initializes a new \doxyref{\-Getopt}{p.}{interface_getopt} response object. 
\begin{DoxyParams}{\-Parameters}
{\em url\-Getopt} & \-U\-R\-L for calling requests from \-Mogreet \-A\-P\-I. \\
\hline
\end{DoxyParams}
\index{\-Getopt@{\-Getopt}!response\-Is\-Valid@{response\-Is\-Valid}}
\index{response\-Is\-Valid@{response\-Is\-Valid}!Getopt@{\-Getopt}}
\subsubsection[{response\-Is\-Valid}]{\setlength{\rightskip}{0pt plus 5cm}-\/ (\-B\-O\-O\-L) response\-Is\-Valid 
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
}\label{interface_getopt_a9ec6a1ac7941b10d44326c16d88e6332}
\-Checks if the response code is 1. \begin{DoxyReturn}{\-Returns}
\-Y\-E\-S if the response code is 1, \-N\-O if it is not 
\end{DoxyReturn}


\-The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
\-Mercury\-\_\-i\-O\-S/\-Classes/\-Getopt.\-h\item 
\-Mercury\-\_\-i\-O\-S/\-Classes/\-Getopt.\-m\end{DoxyCompactItemize}
