home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / AACD / Online / StrICQ / Src / STRICQRexx.doc < prev   
Text File  |  2000-02-15  |  13KB  |  440 lines
  1.  
  2.                          STRICQ's ARexx Interface
  3.  
  4.  
  5. STATUS SET/K,GET/S,ALL/S,VAR/K
  6.  
  7.   Arguments:
  8.  
  9.     SET - This keyword is used to set the status mode.  The status must be one
  10.       of the recognized status' returned by the ALL switch.  Those status'
  11.       that contain spaces can have the spaces replaced by an underscore '_'.
  12.  
  13.     GET - This switch will return the current status mode.  If used in
  14.       conjunction with the SET keyword, GET will return the current status
  15.       before the SET is made.  The returned status will be in the ICQRC
  16.       variable.
  17.  
  18.     ALL - This switch will return all known status' that will work with the SET
  19.       keyword.  The total number of available status' will be returned in ICQRC.
  20.       The individual status' will be returned in the ICQRC.0 to ICQRC.(ICQRC-1)
  21.       stem variables.  As a standard, the first status will always be "Online"
  22.       and the last status will always be "OFFLINE".
  23.  
  24.     VAR - Give the name of a variable in your ARexx script and it will be used
  25.       instead of ICQRC to set return values.
  26.  
  27.   Note:
  28.  
  29.     The GET and ALL switches are mutually exclusive.  If used together, the ALL
  30.     swtich takes priority.
  31.  
  32.   Returns:
  33.  
  34.     RC = 0 - Everything went fine.
  35.  
  36.     RC = 5 - SET did not recognize the status passed to it.
  37.  
  38.   Examples:
  39.  
  40.     STATUS 'SET=ONLINE'
  41.  
  42.     STATUS 'SET=FREE_FOR_CHAT'
  43.  
  44.     STATUS GET; SAY ICQRC
  45.  
  46.       Occupied
  47.  
  48.     STATUS ALL; SAY ICQRC' 'ICQRC.0' 'ICQRC.1
  49.  
  50.       8 Online Invisible
  51.  
  52.     STATUS ALL 'VAR=STATII'; SAY STATII', 'STATII.2', 'STATII.3
  53.  
  54.       8, Not Available, Free For Chat
  55.  
  56.  
  57. GETCONTACT UIN/K,ENTRY/K,SELECTED/S,TOTAL/S,VAR/K
  58.  
  59.   Arguments:
  60.  
  61.     UIN - This keyword is used to provide the UIN of the contact you want
  62.       information about.
  63.  
  64.     ENTRY - This keyword retrieves the contact that is the specified entry in
  65.       the contact list.
  66.  
  67.     SELECTED - This switch will return the current selected user in the contact
  68.       list.  Remember, the contact list is multi-selected, this will only
  69.       return the user the list cursor is currently on.
  70.  
  71.     TOTAL - This switch will return the total number of contacts in the contact
  72.       list.  The actual useable range will be 0 to ICQRC-1.
  73.  
  74.     VAR - Give the name of a variable in your ARexx script and it will be used
  75.       instead of ICQRC to set return values.
  76.  
  77.   Returns:
  78.  
  79.     ICQRC.UIN             - Universal Identification Number.
  80.     ICQRC.NICK            - Nickname.
  81.     ICQRC.FIRST           - First name.
  82.     ICQRC.LAST            - Last name.
  83.     ICQRC.EMAIL           - EMail address.
  84.     ICQRC.EMAIL_SECONDARY - Secondary EMail address.
  85.     ICQRC.EMAIL_OLD       - Old EMail address.
  86.     ICQRC.CITY            - City.
  87.     ICQRC.STATE           - State.
  88.     ICQRC.COUNTRY         - Country of user or 'Unspecified'.
  89.     ICQRC.PHONE           - Telephone number.
  90.     ICQRC.FAX             - FAX number.
  91.     ICQRC.CELLULAR        - Cellular number.
  92.     ICQRC.HOMEPAGE        - Homepage, generally a WWW URL.
  93.     ICQRC.ABOUT           - Personal comment.
  94.     ICQRC.AGE             - Age or 'Unspecified'.
  95.     ICQRC.SEX             - 'Unspecified', 'Female', or 'Male'.
  96.     ICQRC.COMMENT         - The local comment about this contact.
  97.     ICQRC.IP              - If online, current IP address or '0.0.0.0'
  98.     ICQRC.PORT            - Port associated with IP address.
  99.     ICQRC.NEWMSGS         - Number of unread messages.  Cleared when window opens.
  100.     ICQRC.STATUS          - Current status.  Different case as returned by STATUS.
  101.     ICQRC.LAST_ONLINE     - Date and time last seen online.
  102.     ICQRC.MESSAGE_TO      - Date and time a message was last sent to this UIN.
  103.     ICQRC.MESSAGE_FROM    - Date and time a message was last received from this UIN.
  104.  
  105.     RC = 0 - Everything went fine.
  106.  
  107.     RC = 5 - The UIN was not found in the contact list, the ENTRY was out of
  108.       range, or there is no SELECTED entry.
  109.  
  110.   Examples:
  111.  
  112.     GETCONTACT 'UIN=8083608'; SAY ICQRC.NICK' is currently 'ICQRC.STATUS'.'
  113.  
  114.       Black Fire is currently Online.
  115.  
  116.     GETCONTACT 'UIN=8083608' 'VAR=USER'; SAY USER.FIRST
  117.  
  118.       Douglas
  119.  
  120.     GETCONTACT TOTAL; SAY ICQRC
  121.  
  122.       543
  123.  
  124.     GETCONTACT 'ENTRY=0' 'VAR=USER'; SAY USER.UIN
  125.  
  126.       8083608
  127.  
  128.     GETCONTACT SELECTED; SAY ICQRC.NICK
  129.  
  130.       Black Fire
  131.  
  132.  
  133. SENDMESSAGE UIN/K,MSG/K,URL/K,FILE/K
  134.  
  135.   Description:
  136.  
  137.     This command sends a message or URL to the specified UIN.
  138.  
  139.   Arguments:
  140.  
  141.     UIN - This keyword is used to provide the UIN of the contact you want
  142.       to send a message.  The UIN does NOT need to be in your Contact List.
  143.  
  144.     MSG - The message to be sent.  It must be enclosed in quotes.  If a URL
  145.       is being sent, this will be the description of the URL.
  146.  
  147.     URL - This a WWW URL to send.  It must be enclosed in quotes.
  148.  
  149.     FILE - Instead of using MSG to send a message, this keyword specifies a
  150.       filename that holds the text of the message to be sent.  This gets
  151.       around a ReadArgs() limitation that prevents the MSG keyword from correctly
  152.       handling messages that contain carriage returns and/or linefeeds.  The
  153.       FILE keyword takes priority over MSG if both are used.
  154.  
  155.   Returns:
  156.  
  157.     RC = 0  - Everything went fine.
  158.  
  159.     RC = 5  - Either UIN/K or MSG/K is missing.  Both are required.
  160.  
  161.     RC = 10 - The client is currently offline.
  162.  
  163.     RC = 15 - The filename specified by FILE was not found.
  164.  
  165.   Examples:
  166.  
  167.     SENDMESSAGE 'UIN=8083608' 'MSG="Hello.  How are you"'
  168.  
  169.     SENDMESSAGE 'UIN=13944050' 'MSG="My home page."' URL="http://stricq.owlnet.net//"'
  170.  
  171.     GREET = 'The current time is 'TIME()'.'
  172.     SENDMESSAGE 'UIN=8083608' 'MSG="'GREET'"'
  173.  
  174.     SENDMESSAGE 'UIN=13944050' 'FILE=T:TempMsg'
  175.  
  176.     SENDMESSAGE 'UIN=8083608' 'URL="http://ann.lu/"' 'FILE="T:ANN.txt"'
  177.  
  178.  
  179. WINCONTROL WIN/K,OPEN/S,CLOSE/S,UIN/K
  180.  
  181.   Description:
  182.  
  183.     This command allows for the opening or closing of most every window used
  184.     by STRICQ.
  185.  
  186.   Arguments:
  187.  
  188.     WIN - This keyword is used to supply the name of the window to open.  If
  189.       the window to be opened is a user window, supply the UIN of the user.
  190.       Remember that the user windows are created on the fly, each window
  191.       opened will use more RAM.  If the user window creation fails, an error
  192.       will be returned.  For other windows, use one of the predefined window
  193.       names listed:
  194.  
  195.       ACTIVESOCKETS    - The 'Active Sockets' window.
  196.       ACTIVITYLOG      - The 'Activity Log' window.
  197.       FILEDIRECT       - The 'FileDirect Request' window.
  198.       ICQPREFERENCES   - The 'ICQ Preferences' window.
  199.       INCOMINGMESSAGES - The 'Incoming Messages' window.
  200.       MESSAGEHISTORY   - The 'Message History' window.
  201.       PAGERMESSAGES    - The 'Pager Messages' window.
  202.       STRICQ           - The 'STRICQ' window.
  203.       STRICQLOG        - The 'STRICQ Log' window.
  204.       SYSTEMMESSAGE    - The 'System Message' window.
  205.       USERINFORMATION  - The 'User Information' window.
  206.  
  207.     OPEN - Supplying this switch will cause the specified window to be
  208.       opened.  If neither OPEN nor CLOSE are supplied, OPEN is default.
  209.  
  210.     CLOSE - Supplying this switch will cause the specified window to be
  211.       closed.  This switch takes priority over the OPEN switch if both are
  212.       used at the same time.
  213.  
  214.     UIN - When this keyword is supplied, the WIN argument can be only one of
  215.       two windows listed below.  These windows are controlled by the Contact
  216.       List and therefore the UIN must already exist.  Note:  It is possible
  217.       for one of these windows to fail to open and still return RC = 0 mainly
  218.       due to a lack of available RAM to create the window.
  219.  
  220.       TRANSFER - The File Direct window belonging to the supplied UIN..
  221.       CHAT     - The Chat window belonging to the supplied UIN.  (DEPRECATED)
  222.  
  223.   Returns:
  224.  
  225.     RC = 0  - Everything went fine.
  226.  
  227.     RC = 5  - Was unable to create the user window.
  228.  
  229.     RC = 10 - The UIN was not found in the contact list.
  230.  
  231.   Examples:
  232.  
  233.     WINCONTROL 'WIN=8083608' OPEN
  234.  
  235.     WINCONTROL 'WIN=13944050' CLOSE
  236.  
  237.     WINCONTROL 'WIN=FILEDIRECT'
  238.  
  239.     WINCONTROL 'WIN=STRICQ' CLOSE
  240.  
  241.     WINCONTROL 'WIN=CHAT' 'UIN=8083608'
  242.  
  243.     WINCONTROL 'WIN=TRANSFER' 'UIN=13944050' CLOSE
  244.  
  245.  
  246. ADDFILE FILE/K,REMOVE/S,CLEAR/S
  247.  
  248.   Description:
  249.  
  250.     This command adds or removes files from the FileDirect window.
  251.  
  252.   Arguments:
  253.  
  254.     FILE - This keyword is used to supply the full path to a file that is to
  255.       be added to the 'FileDirect Request' window listing.
  256.  
  257.     REMOVE - If this switch is supplied, the file will be removed from the
  258.       list if it is already in the list.
  259.  
  260.     CLEAR - If this switch is supplied, the files listing in the 'File Direct
  261.       Request' window will be emptied.
  262.  
  263.   Returns:
  264.  
  265.     RC = 0 - Everything went fine.
  266.  
  267.     RC = 5 - Either the file to be added was not found or the file to be
  268.       removed was not found in the list.
  269.  
  270.   Examples:
  271.  
  272.     ADDFILE 'FILE=DH0:Pictures/CoolPic.jpg'
  273.  
  274.     ADDFILE 'FILE=DH0:Pictures/RatedX.jpg'
  275.  
  276.     ADDFILE 'FILE=DH0:Pictures/RatedX.jpg' REMOVE
  277.  
  278.     ADDFILE CLEAR
  279.  
  280.  
  281. FILEDIRECT UIN/K,DESC/K,SPEED/K
  282.  
  283.   Description:
  284.  
  285.     This command initiates the filedirect process with the supplied UIN.
  286.  
  287.   Arguments:
  288.  
  289.     UIN - This keyword is used to provide the UIN of the contact you want to
  290.       send the currently selected files.  The UIN MUST be in the contact list.
  291.  
  292.     DESC - This keyword is used to supply a description of the file(s) being
  293.       sent.  The text must be enclosed in quotes.  If not given it defaults
  294.       to, "Here are some files."
  295.  
  296.     SPEED - This keyword allows for the setting of the intial speed for the
  297.       transfer.  Allowable values range from 0 to 100 percent and defaults to
  298.       100 if the keyword is not given.  Starting at 99%, each 1% down adds a
  299.       .05 second delay between the sending of each packet of the file.  0 will
  300.       will place the transfer into 'Paused' mode while 100 has no delay.
  301.  
  302.   Returns:
  303.  
  304.     RC = 0  - Everything went fine.
  305.  
  306.     RC = 5  - Either the UIN keyword was not given or there are no files listed
  307.       in the 'FileDirect Request' window.
  308.  
  309.     RC = 10 - The UIN was not found in the contact list.
  310.  
  311.   Examples:
  312.  
  313.     FILEDIRECT 'UIN=8083608' 'DESC="Here is that cool picture."'
  314.  
  315.     FILEDIRECT 'UIN=13944050'
  316.  
  317.     FILEDIRECT 'UIN=8083608' 'DESC="Full speed ahead!"' 'SPEED=100'
  318.  
  319.  
  320. GETVERSION FULL/S
  321.  
  322.   Description:
  323.  
  324.     Returns the current version of STRICQ in either numeric or full text mode.
  325.  
  326.   Arguments:
  327.  
  328.     FULL - Returns the full text of the About window.
  329.  
  330.   Returns:
  331.  
  332.     ICQRC - Either the version as a number 0.0000 or the full text of the About
  333.       window if the FULL switch is used.
  334.  
  335.   Examples:
  336.  
  337.     GETVERSION; SAY ICQRC
  338.  
  339.       0.1726
  340.  
  341.     GETVERSION FULL; SAY ICQRC
  342.  
  343.       $VER: STRICQ 0.1726 (15.02.00)
  344.  
  345.       Copyright © 1998-2000 Douglas F. McLaughlin
  346.       ICQ Protocol Copyright © 1996 Mirabilis LTD.
  347.  
  348.       All Rights Reserved.
  349.  
  350.  
  351. DELETEUIN UIN/K
  352.  
  353.   Description:
  354.  
  355.     This command will delete a UIN from the contact list, remove its prefs
  356.     file from the Users directory and remove the message log from the Log
  357.     directory.  This command is final with no second chance.
  358.  
  359.   Arguments:
  360.  
  361.     UIN - The UIN to delete from the contact list.
  362.  
  363.   Returns:
  364.  
  365.     RC = 0  - Everything went fine.
  366.  
  367.     RC = 10 - The UIN was not found in the contact list.
  368.  
  369.   Examples:
  370.  
  371.     DELETEUIN 'UIN=8083608'
  372.  
  373.  
  374. GETFILES VAR/K
  375.  
  376.   Description:
  377.  
  378.     This command will return all files currently listed in the FileDirect Send
  379.     window.
  380.  
  381.   Arguments:
  382.  
  383.     VAR - Give the name of a variable in your ARexx script and it will be used
  384.       instead of ICQRC to set return values.
  385.  
  386.   Returns:
  387.  
  388.     ICQRC.0      - Total number is files returned.
  389.  
  390.       (Valid range from 0 to ICQRC.0 - 1)
  391.  
  392.     ICQRC.NAME.0 - Full path and filename of a file in the send window.
  393.     ICQRC.SIZE.0 - Size in bytes of the file.
  394.  
  395.     RC = 0 - Everything went fine.
  396.  
  397.     RC = 5 - There are no files currently queued to send.
  398.  
  399.   Examples:
  400.  
  401.     GETFILES; SAY ICQRC.0' 'ICQRC.NAME.0
  402.  
  403.       1 DH0:Pictures/SomePic.jpg
  404.  
  405.  
  406. ACCEPT UIN/K,ACCEPT/S,DECLINE/S
  407.  
  408.   Description:
  409.  
  410.     This command will either accept or decline any incoming chat or file
  411.     request messages.  The UIN/K is required.  If neither ACCEPT/S or
  412.     DECLINE/S are present, ACCEPT/S is the default.  If both are used,
  413.     DECLINE/S will be default.
  414.  
  415.   Arguments:
  416.  
  417.     UIN - The UIN of the person requesting chat or to send a file.
  418.  
  419.     ACCEPT - This will start the chat mode or file send process.
  420.  
  421.     DECLINE - This will cancel the chat mode or file send process.
  422.  
  423.   Returns:
  424.  
  425.     RC = 0  - Everything went fine.
  426.  
  427.     RC = 5  - The supplied UIN is not requesting chat or file.
  428.  
  429.     RC = 10 - The supplied UIN is not in the contact list.
  430.  
  431.     RC = 20 - The UIN/K argument is missing.
  432.  
  433.   Examples:
  434.  
  435.     ACCEPT 'UIN=8083608'
  436.  
  437.     ACCEPT 'UIN=8083608' ACCEPT
  438.  
  439.     ACCEPT 'UIN=8083608' DECLINE
  440.